couchbase-memcached 1.2.8

data/lib/memcached/rails.rb

@@ -0,0 +1,133 @@
+class Memcached
+
+  (instance_methods - NilClass.instance_methods).each do |method_name|
+    eval("alias :'#{method_name}_orig' :'#{method_name}'")
+  end
+
+  # A legacy compatibility wrapper for the Memcached class. It has basic compatibility with the <b>memcache-client</b> API.
+  class Rails < ::Memcached
+
+    DEFAULTS = {
+      :logger => nil,
+      :string_return_types => false
+    }
+
+    attr_reader :logger
+
+    alias :servers= :set_servers
+
+    # See Memcached#new for details.
+    def initialize(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      servers = Array(
+        args.any? ? args.unshift : opts.delete(:servers)
+      ).flatten.compact
+
+      opts[:prefix_key] ||= opts[:namespace]
+      @logger = opts[:logger]
+      @string_return_types = opts[:string_return_types]
+
+      logger.info { "memcached #{VERSION} #{servers.inspect}" } if logger
+      super(servers, opts)
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    # Wraps Memcached#get so that it doesn't raise. This has the side-effect of preventing you from
+    # storing <tt>nil</tt> values.
+    def get(key, raw=false)
+      super(key, !raw)
+    rescue NotFound
+    end
+
+    # Alternative to #get. Accepts a key and an optional options hash supporting the single option
+    # :raw.
+    def read(key, options = {})
+      get(key, options[:raw])
+    end
+
+    # Returns whether the key exists, even if the value is nil.
+    def exist?(key, options = {})
+      get_orig(key, options)
+      true
+    rescue NotFound
+      false
+    end
+
+    # Wraps Memcached#cas so that it doesn't raise. Doesn't set anything if no value is present.
+    def cas(key, ttl=@default_ttl, raw=false, &block)
+      super(key, ttl, !raw, &block)
+      true
+    rescue NotFound
+      false
+    end
+
+    alias :compare_and_swap :cas
+
+    # Wraps Memcached#get.
+    def get_multi(keys, raw=false)
+      get_orig(keys, !raw)
+    end
+
+    # Wraps Memcached#set.
+    def set(key, value, ttl=@default_ttl, raw=false)
+      super(key, value, ttl, !raw)
+      true
+    rescue NotStored
+      false
+    end
+
+    # Alternative to #set. Accepts a key, value, and an optional options hash supporting the
+    # options :raw and :ttl.
+    def write(key, value, options = {})
+      set(key, value, options[:ttl] || @default_ttl, options[:raw])
+    end
+
+    # Wraps Memcached#add so that it doesn't raise.
+    def add(key, value, ttl=@default_ttl, raw=false)
+      super(key, value, ttl, !raw)
+      # This causes me  pain
+      @string_return_types ? "STORED\r\n" : true
+    rescue NotStored
+      @string_return_types? "NOT STORED\r\n" : false
+    end
+
+    # Wraps Memcached#delete so that it doesn't raise.
+    def delete(key, expiry=0)
+      super(key)
+    rescue NotFound
+    end
+
+    # Wraps Memcached#incr so that it doesn't raise.
+    def incr(*args)
+      super
+    rescue NotFound
+    end
+
+    # Wraps Memcached#decr so that it doesn't raise.
+    def decr(*args)
+      super
+    rescue NotFound
+    end
+
+    # Wraps Memcached#append so that it doesn't raise.
+    def append(*args)
+      super
+    rescue NotStored
+    end
+
+    # Wraps Memcached#prepend so that it doesn't raise.
+    def prepend(*args)
+      super
+    rescue NotStored
+    end
+
+    alias :flush_all :flush
+
+    alias :"[]" :get
+    alias :"[]=" :set
+
+  end
+end

data/test/profile/benchmark.rb

@@ -0,0 +1,245 @@
+
+HERE = File.dirname(__FILE__)
+$LOAD_PATH << "#{HERE}/../../lib/"
+UNIX_SOCKET_NAME = File.join(ENV['TMPDIR']||'/tmp','memcached')
+
+require 'memcached' if !defined?(JRUBY_VERSION)
+require 'benchmark'
+require 'rubygems'
+require 'ruby-debug' if ENV['DEBUG']
+begin; require 'memory'; rescue LoadError; end
+
+puts `uname -a`
+puts `ruby -v`
+puts `env | egrep '^RUBY'`
+puts "Ruby #{RUBY_VERSION}p#{RUBY_PATCHLEVEL}"
+
+[["memcached"], ["remix-stash", "remix/stash"], ["memcache-client", "memcache"], ["kgio"], ["dalli"]].each do |gem_name, requirement|
+  begin
+    require requirement || gem_name
+    gem gem_name
+    puts "Loaded #{gem_name} #{Gem.loaded_specs[gem_name].version.to_s rescue nil}"
+  rescue LoadError
+  end
+end
+
+class Remix::Stash
+  # Remix::Stash API doesn't let you set servers
+  @@clusters = {:default => Remix::Stash::Cluster.new(['127.0.0.1:43042', '127.0.0.1:43043'])}
+end
+
+class Dalli::ClientCompat < Dalli::Client
+  def set(*args)
+    super(*args[0..2])
+  end
+  def get(*args)
+    super(args.first)
+  end
+  def get_multi(*args)
+    super(args.first)
+  end
+  def append(*args)
+    super
+  rescue Dalli::DalliError
+  end
+  def prepend(*args)
+    super
+  rescue Dalli::DalliError
+  end
+end
+
+class Bench
+
+  def initialize(loops = nil, stack_depth = nil)
+    @loops = (loops || 20000).to_i
+    @stack_depth = (stack_depth || 0).to_i
+
+    puts "PID is #{Process.pid}"
+    puts "Loops is #{@loops}"
+    puts "Stack depth is #{@stack_depth}"
+
+    @m_value = Marshal.dump(
+      @small_value = ["testing"])
+    @m_large_value = Marshal.dump(
+      @large_value = [{"test" => "1", "test2" => "2", Object.new => "3", 4 => 4, "test5" => 2**65}] * 2048)
+
+    puts "Small value size is: #{@m_value.size} bytes"
+    puts "Large value size is: #{@m_large_value.size} bytes"
+
+    @keys = [
+      @k1 = "Short",
+      @k2 = "Sym1-2-3::45" * 8,
+      @k3 = "Long" * 40,
+      @k4 = "Medium" * 8,
+      @k5 = "Medium2" * 8,
+      @k6 = "Long3" * 40]
+
+    reset_servers
+    reset_clients
+
+    Benchmark.bm(36) do |x|
+      @benchmark = x
+    end
+  end
+
+  def run(level = @stack_depth)
+    level > 0 ? run(level - 1) : run_without_recursion
+  end
+
+  private
+
+  def reset_servers
+    system("ruby #{HERE}/../setup.rb")
+    sleep(1)
+  end
+
+  def reset_clients
+    @clients = {
+      "mclient:ascii" => MemCache.new(['127.0.0.1:43042', '127.0.0.1:43043']),
+      "stash:bin" => Remix::Stash.new(:root),
+      "dalli:bin" => Dalli::ClientCompat.new(['127.0.0.1:43042', '127.0.0.1:43043'], :marshal => false, :threadsafe => false)}
+
+    if defined?(JRUBY_VERSION)
+      @clients.merge!({}) # jruby-memcache-client, #spymemcached
+    else
+      @clients.merge!({
+        "libm:ascii" => Memcached::Rails.new(
+          ['127.0.0.1:43042', '127.0.0.1:43043'],
+          :buffer_requests => false, :no_block => false, :namespace => "namespace"),
+        "libm:ascii:pipeline" => Memcached::Rails.new(
+          ['127.0.0.1:43042', '127.0.0.1:43043'],
+          :no_block => true, :buffer_requests => true, :noreply => true, :namespace => "namespace"),
+        "libm:ascii:udp" => Memcached::Rails.new(
+          ["#{UNIX_SOCKET_NAME}0", "#{UNIX_SOCKET_NAME}1"],
+          :buffer_requests => false, :no_block => false, :namespace => "namespace"),
+        "libm:bin" => Memcached::Rails.new(
+          ['127.0.0.1:43042', '127.0.0.1:43043'],
+          :buffer_requests => false, :no_block => false, :namespace => "namespace", :binary_protocol => true),
+        "libm:bin:buffer" => Memcached::Rails.new(
+          ['127.0.0.1:43042', '127.0.0.1:43043'],
+          :no_block => true, :buffer_requests => true, :namespace => "namespace", :binary_protocol => true)})
+    end
+  end
+
+  def benchmark_clients(test_name, populate_keys = true)
+    return if ENV["TEST"] and !test_name.include?(ENV["TEST"])
+
+    @clients.keys.sort.each do |client_name|
+      next if ENV["CLIENT"] and !client_name.include?(ENV["CLIENT"])
+      next if client_name == "stash" and test_name == "set-large" # Don't let stash break the world
+
+      client = @clients[client_name]
+      begin
+        if populate_keys
+          client.set @k1, @m_value, 0, true
+          client.set @k2, @m_value, 0, true
+          client.set @k3, @m_value, 0, true
+        else
+          client.delete @k1
+          client.delete @k2
+          client.delete @k3
+        end
+        yield client
+        GC.disable
+        @benchmark.report("#{test_name}: #{client_name}") { @loops.times { yield client } }
+      rescue Exception => e
+        puts "#{test_name}: #{client_name} => #{e.inspect}" if ENV["DEBUG"]
+        reset_clients
+      end
+      GC.enable
+    end
+    puts
+  end
+
+  def benchmark_hashes(hashes, test_name)
+    hashes.each do |hash_name, int|
+      @m = Memcached::Rails.new(:hash => hash_name)
+      @benchmark.report("#{test_name}:#{hash_name}") do
+        (@loops * 5).times { yield int }
+      end
+    end
+  end
+
+  def run_without_recursion
+    benchmark_clients("set") do |c|
+      c.set @k1, @m_value, 0, true
+      c.set @k2, @m_value, 0, true
+      c.set @k3, @m_value, 0, true
+    end
+
+    benchmark_clients("get") do |c|
+      c.get @k1, true
+      c.get @k2, true
+      c.get @k3, true
+    end
+
+    benchmark_clients("get-multi") do |c|
+      c.get_multi @keys, true
+    end
+
+    benchmark_clients("append") do |c|
+      c.append @k1, @m_value
+      c.append @k2, @m_value
+      c.append @k3, @m_value
+    end
+
+    benchmark_clients("prepend") do |c|
+      c.prepend @k1, @m_value
+      c.prepend @k2, @m_value
+      c.prepend @k3, @m_value
+    end
+
+    benchmark_clients("delete") do |c|
+      c.delete @k1
+      c.delete @k2
+      c.delete @k3
+    end
+
+    benchmark_clients("get-missing", false) do |c|
+      c.get @k1
+      c.get @k2
+      c.get @k3
+    end
+
+    benchmark_clients("append-missing", false) do |c|
+      c.append @k1, @m_value
+      c.append @k2, @m_value
+      c.append @k3, @m_value
+    end
+
+    benchmark_clients("prepend-missing", false) do |c|
+      c.prepend @k1, @m_value
+      c.prepend @k2, @m_value
+      c.prepend @k3, @m_value
+    end
+
+    benchmark_clients("set-large") do |c|
+      c.set @k1, @m_large_value, 0, true
+      c.set @k2, @m_large_value, 0, true
+      c.set @k3, @m_large_value, 0, true
+    end
+
+    benchmark_clients("get-large") do |c|
+      c.get @k1, true
+      c.get @k2, true
+      c.get @k3, true
+    end
+
+    if defined?(Memcached)
+      benchmark_hashes(Memcached::HASH_VALUES, "hash") do |i|
+        Rlibmemcached.memcached_generate_hash_rvalue(@k1, i)
+        Rlibmemcached.memcached_generate_hash_rvalue(@k2, i)
+        Rlibmemcached.memcached_generate_hash_rvalue(@k3, i)
+        Rlibmemcached.memcached_generate_hash_rvalue(@k4, i)
+        Rlibmemcached.memcached_generate_hash_rvalue(@k5, i)
+        Rlibmemcached.memcached_generate_hash_rvalue(@k6, i)
+      end
+    end
+  end
+end
+
+Bench.new(ENV["LOOPS"], ENV["STACK_DEPTH"]).run
+
+Process.memory.each do |key, value|
+  puts "#{key}: #{value/1024.0}M"
+end if Process.respond_to? :memory

data/test/profile/c_profiler.rb

@@ -0,0 +1,14 @@
+require "#{File.dirname(__FILE__)}/../setup"
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../../lib/"
+require 'memcached'
+
+profile = "/tmp/memcached_#{Memcached::VERSION}_c"
+
+system("env CPUPROFILE_FREQUENCY=500 CPUPROFILE=#{profile}.out DYLD_INSERT_LIBRARIES=/opt/local/lib/libprofiler.dylib ruby -r#{File.dirname(__FILE__)}/exercise -e \"Worker.new('mixed', 200000).work\"")
+
+ruby = `which ruby`.chomp
+
+system("pprof --nodefraction=0.0000001 --text #{ruby} #{profile}.out")
+system("pprof --nodefraction=0.0000001 --pdf #{ruby} #{profile}.out > #{profile}.pdf")
+system("open #{profile}.pdf")

data/test/profile/exercise.rb

@@ -0,0 +1,185 @@
+
+require "#{File.dirname(__FILE__)}/../setup"
+
+$LOAD_PATH << "#{File.dirname(__FILE__)}/../../lib/"
+require 'memcached'
+require 'rubygems'
+require 'ostruct'
+
+GC.copy_on_write_friendly = true if GC.respond_to?("copy_on_write_friendly=")
+
+class Worker
+  def initialize(method_name, iterations, with_memory = 'false')
+    @method = method_name || 'mixed'
+    @i = (iterations || 10000).to_i
+    @with_memory = with_memory
+
+    puts "*** Running #{@method.inspect} test for #{@i} loops. ***"
+
+    @key1 = "key1--------------------------------"
+    @key2 = "key2--------------------------------"
+    @key3 = "key3--------------------------------"
+
+    @value = OpenStruct.new(
+      :a => 1, :b => 2, "array" => [1, 2, 3], "hash" => {:badger => 1}
+    )
+    @marshalled = Marshal.dump(@value)
+
+    @opts = [
+      ['localhost:43042', 'localhost:43043', 'localhost:43044'],
+      {
+        :buffer_requests => true,
+        :no_block => true,
+        :noreply => false,
+        :namespace => "namespace"
+      }
+    ]
+    @cache = Memcached::Rails.new(*@opts)
+
+    @cache.set @key1, @value
+  end
+
+  def work
+    case @method
+      when "set"
+        @i.times do
+          @cache.set @key1, @value
+        end
+      when "get"
+        @i.times do
+          @cache.get @key1
+        end
+      when "delete"
+        @i.times do
+          @cache.set @key1, @value
+          @cache.delete @key1
+        end
+      when "delete-miss"
+        @i.times do
+          @cache.delete @key1
+        end
+      when "get-miss"
+        @i.times do
+          @cache.get @key2
+        end
+      when "get-increasing"
+        one_k = "x"*1024
+        @i.times do |i|
+          @cache.set @key1, one_k*(i+1), 0, false
+          @cache.get @key1, false
+        end
+      when "get-miss-increasing"
+        @i.times do |i|
+          @cache.delete @key2
+          @cache.get @key2
+        end
+      when "add"
+        @i.times do
+          @cache.delete @key1
+          @cache.add @key1, @value
+        end
+      when "add-present"
+        @cache.set @key1, @value
+        @i.times do
+          @cache.add @key1, @value
+        end
+      when "mixed"
+        @i.times do
+          @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
+        end
+      when "everything"
+        @i.times do
+          @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 = Memcached::Rails.new(*@opts)
+          cache = @cache.clone
+          servers = @cache.servers
+          server = @cache.server_by_key(@key1)
+          @cache.stats
+        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])
+        end
+      when "clone"
+        @i.times do
+          cache = @cache.clone
+        end
+      when "reset"
+        @i.times do
+          @cache.reset
+        end
+      when "servers"
+        @i.times do
+          @cache.servers
+        end
+      when "server_by_key"
+        @i.times do
+          @cache.server_by_key(@key1)
+        end
+      when "server_error"
+        @i.times do
+          begin
+            @cache.set @key1, "I'm big" * 1000000
+          rescue
+          end
+        end
+      else
+        raise "No such method"
+    end
+
+    @cache = nil
+
+    if @with_memory == "true"
+      puts "*** Garbage collect. ***"
+      10.times do
+        GC.start
+        sleep 0.1
+      end
+
+      sts, server_sts, clients = 0, 0, 0
+      ObjectSpace.each_object(Memcached) { clients += 1 }
+      ObjectSpace.each_object(Rlibmemcached::MemcachedSt) { sts += 1 }
+      ObjectSpace.each_object(Rlibmemcached::MemcachedServerSt) { server_sts += 1 }
+      puts "*** memcached_st structs: #{sts} ***"
+      puts "*** memcached_server_st structs: #{server_sts} ***"
+      puts "*** Memcached instances: #{clients} ***"
+
+      begin;
+        require 'memory'
+        Process.memory.each { |key, value| puts "#{key}: #{value/1024.0}M" }
+      rescue LoadError
+      end
+    end
+  end
+end