msgpack 1.5.6 → 1.6.0

data/ext/msgpack/unpacker_class.c

@@ -37,15 +37,9 @@ static VALUE sym_symbolize_keys;
 static VALUE sym_freeze;
 static VALUE sym_allow_unknown_ext;
 
-#define UNPACKER(from, name) \
-    msgpack_unpacker_t *name = NULL; \
-    Data_Get_Struct(from, msgpack_unpacker_t, name); \
-    if(name == NULL) { \
-        rb_raise(rb_eArgError, "NULL found for " # name " when shouldn't be."); \
-    }
-
-static void Unpacker_free(msgpack_unpacker_t* uk)
+static void Unpacker_free(void *ptr)
 {
+    msgpack_unpacker_t* uk = ptr;
     if(uk == NULL) {
         return;
     }
@@ -54,17 +48,43 @@ static void Unpacker_free(msgpack_unpacker_t* uk)
     xfree(uk);
 }
 
-static void Unpacker_mark(msgpack_unpacker_t* uk)
+static void Unpacker_mark(void *ptr)
 {
+    msgpack_unpacker_t* uk = ptr;
     msgpack_unpacker_mark(uk);
     msgpack_unpacker_ext_registry_mark(uk->ext_registry);
 }
 
-VALUE MessagePack_Unpacker_alloc(VALUE klass)
+static size_t Unpacker_memsize(const void *ptr)
 {
-    msgpack_unpacker_t* uk = _msgpack_unpacker_new();
+    size_t total_size = sizeof(msgpack_unpacker_t);
+
+    const msgpack_unpacker_t* uk = ptr;
+    if (uk->ext_registry) {
+        total_size += sizeof(msgpack_unpacker_ext_registry_t) / (uk->ext_registry->borrow_count + 1);
+    }
 
-    VALUE self = Data_Wrap_Struct(klass, Unpacker_mark, Unpacker_free, uk);
+    total_size += (uk->stack->depth + 1) * sizeof(msgpack_unpacker_stack_t);
+
+    return total_size + msgpack_buffer_memsize(&uk->buffer);
+}
+
+const rb_data_type_t unpacker_data_type = {
+    .wrap_struct_name = "msgpack:unpacker",
+    .function = {
+        .dmark = Unpacker_mark,
+        .dfree = Unpacker_free,
+        .dsize = Unpacker_memsize,
+    },
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY
+};
+
+VALUE MessagePack_Unpacker_alloc(VALUE klass)
+{
+    msgpack_unpacker_t* uk;
+    VALUE self = TypedData_Make_Struct(klass, msgpack_unpacker_t, &unpacker_data_type, uk);
+    _msgpack_unpacker_init(uk);
+    uk->self = self;
     return self;
 }
 
@@ -95,7 +115,7 @@ VALUE MessagePack_Unpacker_initialize(int argc, VALUE* argv, VALUE self)
         rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..2)", argc);
     }
 
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     uk->buffer_ref = MessagePack_Buffer_wrap(UNPACKER_BUFFER_(uk), self);
 
@@ -119,19 +139,19 @@ VALUE MessagePack_Unpacker_initialize(int argc, VALUE* argv, VALUE self)
 
 static VALUE Unpacker_symbolized_keys_p(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
     return uk->symbolize_keys ? Qtrue : Qfalse;
 }
 
 static VALUE Unpacker_freeze_p(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
     return uk->freeze ? Qtrue : Qfalse;
 }
 
 static VALUE Unpacker_allow_unknown_ext_p(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
     return uk->allow_unknown_ext ? Qtrue : Qfalse;
 }
 
@@ -156,13 +176,13 @@ NORETURN(static void raise_unpacker_error(int r))
 
 static VALUE Unpacker_buffer(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
     return uk->buffer_ref;
 }
 
 static VALUE Unpacker_read(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     int r = msgpack_unpacker_read(uk, 0);
     if(r < 0) {
@@ -174,7 +194,7 @@ static VALUE Unpacker_read(VALUE self)
 
 static VALUE Unpacker_skip(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     int r = msgpack_unpacker_skip(uk, 0);
     if(r < 0) {
@@ -186,7 +206,7 @@ static VALUE Unpacker_skip(VALUE self)
 
 static VALUE Unpacker_skip_nil(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     int r = msgpack_unpacker_skip_nil(uk);
     if(r < 0) {
@@ -201,7 +221,7 @@ static VALUE Unpacker_skip_nil(VALUE self)
 
 static VALUE Unpacker_read_array_header(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     uint32_t size;
     int r = msgpack_unpacker_read_array_header(uk, &size);
@@ -214,7 +234,7 @@ static VALUE Unpacker_read_array_header(VALUE self)
 
 static VALUE Unpacker_read_map_header(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     uint32_t size;
     int r = msgpack_unpacker_read_map_header(uk, &size);
@@ -228,7 +248,7 @@ static VALUE Unpacker_read_map_header(VALUE self)
 
 static VALUE Unpacker_feed(VALUE self, VALUE data)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     StringValue(data);
 
@@ -239,7 +259,7 @@ static VALUE Unpacker_feed(VALUE self, VALUE data)
 
 static VALUE Unpacker_feed_reference(VALUE self, VALUE data)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     StringValue(data);
 
@@ -250,7 +270,7 @@ static VALUE Unpacker_feed_reference(VALUE self, VALUE data)
 
 static VALUE Unpacker_each_impl(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     while(true) {
         int r = msgpack_unpacker_read(uk, 0);
@@ -280,7 +300,7 @@ static VALUE Unpacker_rescue_EOFError(VALUE args, VALUE error)
 
 static VALUE Unpacker_each(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
 #ifdef RETURN_ENUMERATOR
     RETURN_ENUMERATOR(self, 0, 0);
@@ -311,7 +331,7 @@ static VALUE Unpacker_feed_each(VALUE self, VALUE data)
 
 static VALUE Unpacker_reset(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     _msgpack_unpacker_reset(uk);
 
@@ -320,7 +340,7 @@ static VALUE Unpacker_reset(VALUE self)
 
 static VALUE Unpacker_registered_types_internal(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     VALUE mapping = rb_hash_new();
     if (uk->ext_registry) {
@@ -336,7 +356,7 @@ static VALUE Unpacker_registered_types_internal(VALUE self)
 
 static VALUE Unpacker_register_type(int argc, VALUE* argv, VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     int ext_type;
     VALUE proc;
@@ -373,7 +393,7 @@ static VALUE Unpacker_register_type(int argc, VALUE* argv, VALUE self)
 
 static VALUE Unpacker_full_unpack(VALUE self)
 {
-    UNPACKER(self, uk);
+    msgpack_unpacker_t *uk = MessagePack_Unpacker_get(self);
 
     int r = msgpack_unpacker_read(uk, 0);
     if(r < 0) {

data/ext/msgpack/unpacker_class.h

@@ -20,6 +20,17 @@
 
 #include "unpacker.h"
 
+extern const rb_data_type_t unpacker_data_type;
+
+static inline msgpack_unpacker_t *MessagePack_Unpacker_get(VALUE object) {
+    msgpack_unpacker_t *unpacker;
+    TypedData_Get_Struct(object, msgpack_unpacker_t, &unpacker_data_type, unpacker);
+    if (!unpacker) {
+        rb_raise(rb_eArgError, "Uninitialized Unpacker object");
+    }
+    return unpacker;
+}
+
 extern VALUE cMessagePack_Unpacker;
 
 void MessagePack_Unpacker_module_init(VALUE mMessagePack);

data/ext/msgpack/unpacker_ext_registry.c

@@ -21,14 +21,14 @@
 static ID s_call;
 static ID s_dup;
 
-void msgpack_unpacker_ext_registry_static_init()
+void msgpack_unpacker_ext_registry_static_init(void)
 {
     s_call = rb_intern("call");
     s_dup = rb_intern("dup");
 }
 
 
-void msgpack_unpacker_ext_registry_static_destroy()
+void msgpack_unpacker_ext_registry_static_destroy(void)
 { }
 
 void msgpack_unpacker_ext_registry_mark(msgpack_unpacker_ext_registry_t* ukrg)

data/ext/msgpack/unpacker_ext_registry.h

@@ -31,9 +31,9 @@ struct msgpack_unpacker_ext_registry_t {
     VALUE array[256];
 };
 
-void msgpack_unpacker_ext_registry_static_init();
+void msgpack_unpacker_ext_registry_static_init(void);
 
-void msgpack_unpacker_ext_registry_static_destroy();
+void msgpack_unpacker_ext_registry_static_destroy(void);
 
 void msgpack_unpacker_ext_registry_release(msgpack_unpacker_ext_registry_t* ukrg);
 

data/lib/msgpack/version.rb

@@ -1,5 +1,5 @@
 module MessagePack
-  VERSION = "1.5.6"
+  VERSION = "1.6.0"
   # Note for maintainers:
   #  Don't miss building/releasing the JRuby version (rake buld:java)
   #  See "How to build -java rubygems" in README for more details.

data/spec/cruby/buffer_spec.rb

@@ -572,4 +572,21 @@ describe Buffer do
       end
     }
   end
+
+  it "defines a function for ObjectSpace.memsize_of" do
+    skip "JRuby doesn't support ObjectSpace.memsize_of" if IS_JRUBY
+
+    buffer = MessagePack::Buffer.new
+    empty_size = ObjectSpace.memsize_of(buffer)
+    expect(empty_size).to be < 400
+    10.times do
+      buffer << "a" * 500
+    end
+    memsize = ObjectSpace.memsize_of(buffer)
+    expect(memsize).to be > empty_size
+    buffer.read(10)
+    expect(ObjectSpace.memsize_of(buffer)).to be == memsize
+    buffer.read_all
+    expect(ObjectSpace.memsize_of(buffer)).to be == empty_size
+  end
 end

data/spec/factory_spec.rb

@@ -613,6 +613,24 @@ describe MessagePack::Factory do
     end
   end
 
+  describe 'memsize' do
+    it 'works on a fresh factory' do
+      skip "JRuby doesn't support ObjectSpace.memsize_of" if IS_JRUBY
+
+      f = MessagePack::Factory.new
+      expect(ObjectSpace.memsize_of(f)).to be_an(Integer)
+    end
+
+    it 'works on a factory with registered types' do
+      skip "JRuby doesn't support ObjectSpace.memsize_of" if IS_JRUBY
+
+      f = MessagePack::Factory.new
+      base_size = ObjectSpace.memsize_of(f)
+      f.register_type(0x0a, Symbol)
+      expect(ObjectSpace.memsize_of(f)).to be > base_size
+    end
+  end
+
   describe 'DefaultFactory' do
     it 'is a factory' do
       MessagePack::DefaultFactory.should be_kind_of(MessagePack::Factory)

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "set"
+require "objspace"
 
 if ENV['SIMPLE_COV']
   require 'simplecov'

data/spec/unpacker_spec.rb

@@ -664,6 +664,16 @@ describe MessagePack::Unpacker do
       string *= 256
       MessagePack.unpack(MessagePack.pack(string)).encoding.should == string.encoding
     end
+
+    it 'returns correct size for array16 (issue #127)' do
+      unpacker.feed("\xdc\x00\x01\x01")
+      unpacker.read_array_header.should == 1
+    end
+
+    it 'returns correct size for map16 (issue #127)' do
+      unpacker.feed("\xde\x00\x02\x01\x02\x03\x04")
+      unpacker.read_map_header.should == 2
+    end
   end
 
   context 'extensions' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: msgpack
 version: !ruby/object:Gem::Version
-  version: 1.5.6
+  version: 1.6.0
 platform: ruby
 authors:
 - Sadayuki Furuhashi
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - Rakefile
 - appveyor.yml
 - bench/bench.rb
+- bin/console
 - doclib/msgpack.rb
 - doclib/msgpack/buffer.rb
 - doclib/msgpack/core_ext.rb