memcached 1.1.2 → 1.1.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.1.3. Register new objects to fix leaks around memcached_server_st and other rich structs (tobi).
+
 v1.1.2. Fix memory leak in memcached_mget().
 
 v1.1.1. Speed up multiget. Don't cast types on unmarshalled set.

data/README

@@ -7,7 +7,7 @@ An interface to the libmemcached C client.
 
 Copyright 2009 Cloudburst, LLC. Licensed under the AFL 3. See the included LICENSE file. Portions copyright 2007-2009 TangentOrg, Brian Aker, licensed under the BSD license, and used with permission.
 
-The public certificate for this gem is here[http://blog.evanweaver.com/files/evan_weaver-original-public_cert.pem]. 
+The public certificate for this gem is here[http://blog.evanweaver.com/files/evan_weaver-original-public_cert.pem].
 
 If you use this software, please {make a donation}[http://blog.evanweaver.com/donate/], or {recommend Evan}[http://www.workingwithrails.com/person/7739-evan-weaver] at Working with Rails.
 
@@ -26,7 +26,7 @@ You need Ruby 1.8.7 or Ruby 1.9.2. Other versions may work, but are not guarante
 
 Install the gem:
   sudo gem install memcached --no-rdoc --no-ri
-  
+
 == Usage
 
 Start a local networked memcached server:
@@ -36,9 +36,9 @@ Now, in Ruby, require the library and instantiate a Memcached object at a global
 
   require 'memcached'
   $cache = Memcached.new("localhost:11211")
-  
+
 Now you can set things and get things:
- 
+
   value = 'hello'
   $cache.set 'test', value
   $cache.get 'test' #=> "hello"
@@ -55,9 +55,9 @@ You can get multiple values at once:
   value = 'hello'
   $cache.set 'test', value
   $cache.set 'test2', value
-  $cache.get ['test', 'test2', 'missing'] 
+  $cache.get ['test', 'test2', 'missing']
     #=> {"test" => "hello", "test2" => "hello"}
-  
+
 You can set a counter and increment it:
 
   start = 1
@@ -69,7 +69,7 @@ You can set a counter and increment it:
 You can get some server stats:
 
   $cache.stats #=> {..., :bytes_written=>[62], :version=>["1.2.4"] ...}
-  
+
 Note that the API is not the same as that of <b>Ruby-MemCache</b> or <b>memcache-client</b>. In particular, <tt>nil</tt> is a valid record value. Memcached#get does not return <tt>nil</tt> on failure, rather it raises <b>Memcached::NotFound</b>. This is consistent with the behavior of memcached itself. For example:
 
   $cache.set 'test', nil
@@ -79,7 +79,7 @@ Note that the API is not the same as that of <b>Ruby-MemCache</b> or <b>memcache
 
 == Legacy applications
 
-There is a compatibility wrapper for legacy applications called Memcached::Rails. 
+There is a compatibility wrapper for legacy applications called Memcached::Rails.
 
 == Threading
 
@@ -90,14 +90,14 @@ There is a compatibility wrapper for legacy applications called Memcached::Rails
     # Perform operations on cache, not $cache
     cache.set 'example', 1
     cache.get 'example'
-  end  
+  end
 
   # Join the thread so that exceptions don't get lost
   thread.join
-  
+
 == Benchmarks
 
-<b>memcached</b>, correctly configured, is up to 60x faster than <b>memcache-client</b> or <b>dalli</b>. See BENCHMARKS[link:files/BENCHMARKS.html] for details.
+<b>memcached</b>, correctly configured, is between 5x and 60x faster than <b>memcache-client</b> and <b>dalli</b>. See BENCHMARKS[link:files/BENCHMARKS.html] for details.
 
 == Reporting problems
 

data/ext/extconf.rb

@@ -48,7 +48,7 @@ def check_libmemcached
 
   Dir.chdir(HERE) do
     if File.exist?("lib")
-      puts "Libmemcached already built; run 'rake clean' first if you need to rebuild."
+      puts "Libmemcached already configured; run 'rake clean' first if you need to reconfigure."
     else
       # have_sasl check may fail on OSX, skip it
       # unless RUBY_PLATFORM =~ /darwin/ or have_library('sasl2')
@@ -70,12 +70,12 @@ def check_libmemcached
 
       Dir.chdir(BUNDLE_PATH) do
         run("env CFLAGS='-fPIC #{$CFLAGS}' LDFLAGS='-fPIC #{$LDFLAGS}' ./configure --prefix=#{HERE} --without-memcached --disable-shared --disable-utils --disable-dependency-tracking #{$EXTRA_CONF} 2>&1", "Configuring libmemcached.")
-
-        #Running the make command in another script invoked by another shell command solves the "cd ." issue on FreeBSD 6+
-        run("GMAKE_CMD='#{GMAKE_CMD}' CXXFLAGS='#{$CXXFLAGS}' SOURCE_DIR='#{BUNDLE_PATH}' HERE='#{HERE}' ruby ../extconf-make.rb", "Making libmemcached.")
       end
+    end
 
-      system("rm -rf #{BUNDLE_PATH}") unless ENV['DEBUG'] or ENV['DEV']
+    Dir.chdir(BUNDLE_PATH) do
+      #Running the make command in another script invoked by another shell command solves the "cd ." issue on FreeBSD 6+
+      run("GMAKE_CMD='#{GMAKE_CMD}' CXXFLAGS='#{$CXXFLAGS}' SOURCE_DIR='#{BUNDLE_PATH}' HERE='#{HERE}' ruby ../extconf-make.rb", "Making libmemcached.")
     end
   end
 

data/ext/rlibmemcached.i

@@ -13,10 +13,18 @@
 %include "typemaps.i"
 %include "libmemcached/visibility.h"
 
+//// Memory management
+
 // Register libmemcached's struct free function to prevent memory leaks
 %freefunc memcached_st "memcached_free";
 %freefunc memcached_server_st "memcached_server_free";
 
+// Register which functions generate new objects
+%newobject memcached_server_by_key;
+%newobject memcached_create;
+%newobject memcached_clone;
+%newobject memcached_stat_get_value;
+
 // %trackobjects; // Doesn't fix any interesting leaks
 
 //// Input maps
@@ -106,13 +114,13 @@
   $1 = string;
   $2 = &length;
 };
+
+// Strings with lengths
 %typemap(argout) (char *key, size_t *key_length) {
-  // Pushes an empty string when *key_length == 0
   rb_ary_push($result, rb_str_new($1, *$2));
 }
 
 // Array of strings
-
 %typemap(out) (char **) {
   int i;
   VALUE ary = rb_ary_new();
@@ -141,7 +149,8 @@
 //// Manual wrappers
 
 // Single get. SWIG likes to use SWIG_FromCharPtr instead of SWIG_FromCharPtrAndSize because
-// of the retval/argout split, so it truncates return values with \0 in them.
+// of the retval/argout split, so it truncates return values with \0 in them. There is probably a better
+// way to do this.
 VALUE memcached_get_rvalue(memcached_st *ptr, const char *key, size_t key_length, uint32_t *flags, memcached_return *error);
 %{
 VALUE memcached_get_rvalue(memcached_st *ptr, const char *key, size_t key_length, uint32_t *flags, memcached_return *error) {
@@ -193,20 +202,6 @@ VALUE memcached_fetch_rvalue(memcached_st *ptr, char *key, size_t *key_length, u
 };
 %}
 
-// We need to wrap this so it doesn't leak memory. SWIG doesn't want to automatically free. We could
-// maybe use a 'ret' %typemap, but this is ok.
-VALUE memcached_stat_get_rvalue(memcached_st *ptr, memcached_stat_st *stat, char *key, memcached_return *error);
-%{
-VALUE memcached_stat_get_rvalue(memcached_st *ptr, memcached_stat_st *stat, char *key, memcached_return *error) {
-  char *str;
-  VALUE ret;
-  str = memcached_stat_get_value(ptr, stat, key, error);
-  ret = rb_str_new2(str);
-  free(str);
-  return ret;
-};
-%}
-
 // Ruby isn't aware that the pointer is an array... there is probably a better way to do this
 memcached_server_st *memcached_select_server_at(memcached_st *in_ptr, int index);
 %{

data/ext/rlibmemcached_wrap.c

@@ -2294,16 +2294,6 @@ VALUE memcached_fetch_rvalue(memcached_st *ptr, char *key, size_t *key_length, u
 };
 
 
-VALUE memcached_stat_get_rvalue(memcached_st *ptr, memcached_stat_st *stat, char *key, memcached_return *error) {
-  char *str;
-  VALUE ret;
-  str = memcached_stat_get_value(ptr, stat, key, error);
-  ret = rb_str_new2(str);
-  free(str);
-  return ret;
-};
-
-
 memcached_server_st *memcached_select_server_at(memcached_st *in_ptr, int index) {
   return &(in_ptr->hosts[index]);
 };
@@ -6907,7 +6897,7 @@ _wrap_memcached_create(int argc, VALUE *argv, VALUE self) {
   }
   arg1 = (memcached_st *)(argp1);
   result = (memcached_st *)memcached_create(arg1);
-  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_st, 0 |  0 );
+  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_st, SWIG_POINTER_OWN |  0 );
   return vresult;
 fail:
   return Qnil;
@@ -6960,7 +6950,7 @@ _wrap_memcached_clone(int argc, VALUE *argv, VALUE self) {
   }
   arg2 = (memcached_st *)(argp2);
   result = (memcached_st *)memcached_clone(arg1,arg2);
-  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_st, 0 |  0 );
+  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_st, SWIG_POINTER_OWN |  0 );
   return vresult;
 fail:
   return Qnil;
@@ -8190,6 +8180,7 @@ _wrap_memcached_stat_get_value(int argc, VALUE *argv, VALUE self) {
     vresult = SWIG_Ruby_AppendOutput(vresult, SWIG_NewPointerObj((void*)(arg4), SWIGTYPE_p_memcached_return, new_flags));
   }
   if (alloc3 == SWIG_NEWOBJ) free((char*)buf3);
+  free((char*)result);
   return vresult;
 fail:
   if (alloc3 == SWIG_NEWOBJ) free((char*)buf3);
@@ -9101,7 +9092,6 @@ _wrap_memcached_fetch(int argc, VALUE *argv, VALUE self) {
   result = (char *)memcached_fetch(arg1,arg2,arg3,arg4,arg5,arg6);
   vresult = SWIG_FromCharPtr((const char *)result);
   {
-    // Pushes an empty string when *key_length == 0
     rb_ary_push(vresult, rb_str_new(arg2, *arg3));
   }
   if (SWIG_IsTmpObj(res4)) {
@@ -12064,7 +12054,7 @@ _wrap_memcached_server_by_key(int argc, VALUE *argv, VALUE self) {
     arg3 = (size_t) RSTRING_LEN(argv[1]);
   }
   result = (memcached_server_st *)memcached_server_by_key(arg1,(char const *)arg2,arg3,arg4);
-  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_server_st, 0 |  0 );
+  vresult = SWIG_NewPointerObj(SWIG_as_voidptr(result), SWIGTYPE_p_memcached_server_st, SWIG_POINTER_OWN |  0 );
   if (SWIG_IsTmpObj(res4)) {
     vresult = SWIG_Ruby_AppendOutput(vresult, SWIG_From_unsigned_SS_short((*arg4)));
   } else {
@@ -12680,7 +12670,6 @@ _wrap_memcached_fetch_rvalue(int argc, VALUE *argv, VALUE self) {
   result = (VALUE)memcached_fetch_rvalue(arg1,arg2,arg3,arg4,arg5);
   vresult = result;
   {
-    // Pushes an empty string when *key_length == 0
     rb_ary_push(vresult, rb_str_new(arg2, *arg3));
   }
   if (SWIG_IsTmpObj(res4)) {
@@ -12701,59 +12690,6 @@ fail:
 }
 
 
-SWIGINTERN VALUE
-_wrap_memcached_stat_get_rvalue(int argc, VALUE *argv, VALUE self) {
-  memcached_st *arg1 = (memcached_st *) 0 ;
-  memcached_stat_st *arg2 = (memcached_stat_st *) 0 ;
-  char *arg3 = (char *) 0 ;
-  memcached_return *arg4 = (memcached_return *) 0 ;
-  void *argp1 = 0 ;
-  int res1 = 0 ;
-  void *argp2 = 0 ;
-  int res2 = 0 ;
-  int res3 ;
-  char *buf3 = 0 ;
-  int alloc3 = 0 ;
-  memcached_return temp4 ;
-  int res4 = SWIG_TMPOBJ ;
-  VALUE result;
-  VALUE vresult = Qnil;
-  
-  arg4 = &temp4;
-  if ((argc < 3) || (argc > 3)) {
-    rb_raise(rb_eArgError, "wrong # of arguments(%d for 3)",argc); SWIG_fail;
-  }
-  res1 = SWIG_ConvertPtr(argv[0], &argp1,SWIGTYPE_p_memcached_st, 0 |  0 );
-  if (!SWIG_IsOK(res1)) {
-    SWIG_exception_fail(SWIG_ArgError(res1), Ruby_Format_TypeError( "", "memcached_st *","memcached_stat_get_rvalue", 1, argv[0] )); 
-  }
-  arg1 = (memcached_st *)(argp1);
-  res2 = SWIG_ConvertPtr(argv[1], &argp2,SWIGTYPE_p_memcached_stat_st, 0 |  0 );
-  if (!SWIG_IsOK(res2)) {
-    SWIG_exception_fail(SWIG_ArgError(res2), Ruby_Format_TypeError( "", "memcached_stat_st *","memcached_stat_get_rvalue", 2, argv[1] )); 
-  }
-  arg2 = (memcached_stat_st *)(argp2);
-  res3 = SWIG_AsCharPtrAndSize(argv[2], &buf3, NULL, &alloc3);
-  if (!SWIG_IsOK(res3)) {
-    SWIG_exception_fail(SWIG_ArgError(res3), Ruby_Format_TypeError( "", "char *","memcached_stat_get_rvalue", 3, argv[2] ));
-  }
-  arg3 = (char *)(buf3);
-  result = (VALUE)memcached_stat_get_rvalue(arg1,arg2,arg3,arg4);
-  vresult = result;
-  if (SWIG_IsTmpObj(res4)) {
-    vresult = SWIG_Ruby_AppendOutput(vresult, SWIG_From_unsigned_SS_short((*arg4)));
-  } else {
-    int new_flags = SWIG_IsNewObj(res4) ? (SWIG_POINTER_OWN |  0 ) :  0 ;
-    vresult = SWIG_Ruby_AppendOutput(vresult, SWIG_NewPointerObj((void*)(arg4), SWIGTYPE_p_memcached_return, new_flags));
-  }
-  if (alloc3 == SWIG_NEWOBJ) free((char*)buf3);
-  return vresult;
-fail:
-  if (alloc3 == SWIG_NEWOBJ) free((char*)buf3);
-  return Qnil;
-}
-
-
 SWIGINTERN VALUE
 _wrap_memcached_select_server_at(int argc, VALUE *argv, VALUE self) {
   memcached_st *arg1 = (memcached_st *) 0 ;
@@ -13716,7 +13652,6 @@ SWIGEXPORT void Init_rlibmemcached(void) {
   rb_define_module_function(mRlibmemcached, "memcached_get_len_rvalue", _wrap_memcached_get_len_rvalue, -1);
   rb_define_module_function(mRlibmemcached, "memcached_get_from_last_rvalue", _wrap_memcached_get_from_last_rvalue, -1);
   rb_define_module_function(mRlibmemcached, "memcached_fetch_rvalue", _wrap_memcached_fetch_rvalue, -1);
-  rb_define_module_function(mRlibmemcached, "memcached_stat_get_rvalue", _wrap_memcached_stat_get_rvalue, -1);
   rb_define_module_function(mRlibmemcached, "memcached_select_server_at", _wrap_memcached_select_server_at, -1);
   rb_define_module_function(mRlibmemcached, "memcached_select_stat_at", _wrap_memcached_select_stat_at, -1);
   rb_define_module_function(mRlibmemcached, "memcached_generate_hash_rvalue", _wrap_memcached_generate_hash_rvalue, -1);

data/lib/memcached/memcached.rb

@@ -223,12 +223,10 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
   # object.
   #
   def clone
-    # FIXME Memory leak
-    # memcached = super
-    # struct = Lib.memcached_clone(nil, @struct)
-    # memcached.instance_variable_set('@struct', struct)
-    # memcached
-    self.class.new(servers, options.merge(:prefix_key => prefix_key))
+    memcached = super
+    struct = Lib.memcached_clone(nil, @struct)
+    memcached.instance_variable_set('@struct', struct)
+    memcached
   end
 
   # Reset the state of the libmemcached struct. This is useful for changing the server list at runtime.
@@ -561,7 +559,7 @@ Please note that when <tt>:no_block => true</tt>, update methods do not raise on
     keys.each do |key|
        server_structs.size.times do |index|
 
-         value, ret = Lib.memcached_stat_get_rvalue(
+         value, ret = Lib.memcached_stat_get_value(
            @struct,
            Lib.memcached_select_stat_at(@struct, stat_struct, index),
            key)

data/memcached.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{memcached}
-  s.version = "1.1.2"
+  s.version = "1.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Evan Weaver"]
   s.cert_chain = ["/Users/eweaver/p/configuration/gem_certificates/evan_weaver-original-public_cert.pem"]
-  s.date = %q{2011-02-24}
+  s.date = %q{2011-02-27}
   s.description = %q{An interface to the libmemcached C client.}
   s.email = %q{}
   s.extensions = ["ext/extconf.rb"]

data/test/profile/exercise.rb

@@ -97,10 +97,36 @@ class Worker
           @cache.delete @key1
           @cache.delete @key2
         end
-      when "stats"
+      when "everything"
         @i.times do
-          @cache.stats
+          @cache.set @key1, @value
+          @cache.set @key2, @value
+          @cache.get @key1
+          @cache.get @key3
+          @cache.get [@key1, @key2, @key3]
+          @cache.prepend @key1, @marshalled
+          @cache.prepend @key2, @marshalled
+          @cache.delete @key1
+          @cache.delete @key2
+          @cache.prepend @key1, @marshalled
+          @cache.prepend @key2, @marshalled
+          @cache.get @key1
+          @cache.get @key3
+          cache = @cache.clone
+          servers = @cache.servers
+          server = @cache.server_by_key(@key1)
+        end
+        @i.times do
+          @cache.reset
         end
+        system("killall -9 memcached")
+        @i.times do
+          @cache.set @key1, @value rescue nil
+          @cache.get @key3 rescue nil
+          @cache.delete @key2 rescue nil
+        end
+      when "stats"
+        @cache.stats
       when "multiget"
         @i.times do
           @cache.get([@key1, @key2, @key3])
@@ -136,9 +162,9 @@ class Worker
       ObjectSpace.each_object(Memcached) { clients += 1 }
       ObjectSpace.each_object(Rlibmemcached::MemcachedSt) { sts += 1 }
       ObjectSpace.each_object(Rlibmemcached::MemcachedServerSt) { server_sts += 1 }
-      puts "*** Structs: #{sts} ***"
-      puts "*** Server structs: #{server_sts} ***"
-      puts "*** Clients: #{clients} ***"
+      puts "*** memcached_st structs: #{sts} ***"
+      puts "*** memcached_server_st structs: #{server_sts} ***"
+      puts "*** Memcached instances: #{clients} ***"
 
       begin;
         require 'memory'

data/test/profile/valgrind.rb

@@ -1,3 +1,3 @@
 require "#{File.dirname(__FILE__)}/../setup"
 
-exec("valgrind --tool=memcheck --error-limit=no --leak-check=full --show-reachable=no --num-callers=15 --track-fds=yes --workaround-gcc296-bugs=yes --max-stackframe=7304328 --dsymutil=yes --track-origins=yes ruby -r#{File.dirname(__FILE__)}/exercise.rb -e \"Worker.new(ENV['TEST'] || 'mixed', 500, 'true').work\"")
+exec("valgrind --tool=memcheck --error-limit=no --undef-value-errors=no --leak-check=full --show-reachable=no --num-callers=15 --track-fds=yes --workaround-gcc296-bugs=yes --leak-resolution=med --max-stackframe=7304328 --dsymutil=yes ruby -r#{File.dirname(__FILE__)}/exercise.rb -e \"Worker.new(ENV['TEST'] || 'everything', 50, 'true').work\"")

data/test/test_helper.rb

@@ -1,18 +1,16 @@
 
 $LOAD_PATH << "#{File.dirname(__FILE__)}/../lib"
 
-require 'rubygems'
-require 'mocha'
 require 'socket'
 require 'benchmark'
 
-if ENV['DEBUG']
-  require 'ruby-debug'
-end
-
+require 'rubygems'
+require 'ruby-debug' if ENV['DEBUG']
 require 'memcached'
+
 require 'test/unit'
 require 'ostruct'
+require 'mocha'
 
 UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached') unless defined? UNIX_SOCKET_NAME
 

data/test/unit/memcached_test.rb

@@ -20,7 +20,6 @@ class MemcachedTest < Test::Unit::TestCase
       :prefix_key => @prefix_key,
       :hash => :default,
       :distribution => :modula,
-      # binary_protocol does not work -- test_get, test_get, test_append, and test_missing_append will fail when it is set to true.
       :binary_protocol => true}
     @binary_protocol_cache = Memcached.new(@servers, @binary_protocol_options)
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: memcached
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 1
-  - 2
-  version: 1.1.2
+  - 3
+  version: 1.1.3
 platform: ruby
 authors: 
 - Evan Weaver
@@ -36,7 +36,7 @@ cert_chain:
   yZ0=
   -----END CERTIFICATE-----
 
-date: 2011-02-24 00:00:00 -08:00
+date: 2011-02-27 00:00:00 -08:00
 default_executable: 
 dependencies: []