mob-dalli 1.1.4

data/lib/dalli/client.rb

@@ -0,0 +1,291 @@
+# encoding: ascii
+module Dalli
+  class Client
+
+    ##
+    # Dalli::Client is the main class which developers will use to interact with
+    # the memcached server.  Usage:
+    #
+    #   Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5'],
+    #                   :threadsafe => true, :failover => true, :expires_in => 300)
+    #
+    # servers is an Array of "host:port:weight" where weight allows you to distribute cache unevenly.
+    # Both weight and port are optional.  If you pass in nil, Dalli will default to 'localhost:11211'.
+    # Note that the <tt>MEMCACHE_SERVERS</tt> environment variable will override the servers parameter for use
+    # in managed environments like Heroku.
+    #
+    # You can also provide a Unix socket as an argument, for example:
+    #
+    #   Dalli::Client.new("/tmp/memcached.sock")
+    #
+    # Initial testing shows that Unix sockets are about twice as fast as TCP sockets
+    # but Unix sockets only work on localhost.
+    #
+    # Options:
+    # - :failover - if a server is down, look for and store values on another server in the ring.  Default: true.
+    # - :nonascii - allow the use of nonascii key names.  Default: false.
+    # - :threadsafe - ensure that only one thread is actively using a socket at a time. Default: true.
+    # - :expires_in - default TTL in seconds if you do not pass TTL as a parameter to an individual operation, defaults to 0 or forever
+    # - :compression - defaults to false, if true Dalli will compress values larger than 100 bytes before
+    #   sending them to memcached.
+    # - :async - assume its running inside the EM reactor. Requires em-synchrony to be installed. Default: false.
+    #
+    def initialize(servers=nil, options={})
+      @servers = env_servers || servers || 'localhost:11211'
+      @options = { :expires_in => 0 }.merge(options)
+      self.extend(Dalli::Client::MemcacheClientCompatibility) if Dalli::Client.compatibility_mode
+      @ring = nil
+    end
+
+    ##
+    # Turn on compatibility mode, which mixes in methods in memcache_client_compatibility.rb
+    # This value is set to true in memcache-client.rb.
+    def self.compatibility_mode
+      @compatibility_mode ||= false
+    end
+
+    def self.compatibility_mode=(compatibility_mode)
+      require 'dalli/compatibility'
+      @compatibility_mode = compatibility_mode
+    end
+
+    #
+    # The standard memcached instruction set
+    #
+
+    ##
+    # Turn on quiet aka noreply support.
+    # All relevant operations within this block will be effectively
+    # pipelined as Dalli will use 'quiet' operations where possible.
+    # Currently supports the set, add, replace and delete operations.
+    def multi
+      old, Thread.current[:dalli_multi] = Thread.current[:dalli_multi], true
+      yield
+    ensure
+      Thread.current[:dalli_multi] = old
+    end
+
+    def get(key, options=nil)
+      resp = perform(:get, key)
+      (!resp || resp == 'Not found') ? nil : resp
+    end
+
+    ##
+    # Fetch multiple keys efficiently.
+    # Returns a hash of { 'key' => 'value', 'key2' => 'value1' }
+    def get_multi(*keys)
+      return {} if keys.empty?
+      options = nil
+      options = keys.pop if keys.last.is_a?(Hash) || keys.last.nil?
+      ring.lock do
+        keys.flatten.each do |key|
+          begin
+            perform(:getkq, key)
+          rescue DalliError, NetworkError => e
+            Dalli.logger.debug { e.message }
+            Dalli.logger.debug { "unable to get key #{key}" }
+          end
+        end
+
+        values = {}
+        ring.servers.each do |server|
+          next unless server.alive?
+          begin
+            server.request(:noop).each_pair do |key, value|
+              values[key_without_namespace(key)] = value
+            end
+          rescue DalliError, NetworkError => e
+            Dalli.logger.debug { e.message }
+            Dalli.logger.debug { "results from this server will be missing" }
+          end
+        end
+        values
+      end
+    end
+
+    def fetch(key, ttl=nil, options=nil)
+      ttl ||= @options[:expires_in]
+      val = get(key, options)
+      if val.nil? && block_given?
+        val = yield
+        add(key, val, ttl, options)
+      end
+      val
+    end
+
+    ##
+    # compare and swap values using optimistic locking.
+    # Fetch the existing value for key.
+    # If it exists, yield the value to the block.
+    # Add the block's return value as the new value for the key.
+    # Add will fail if someone else changed the value.
+    #
+    # Returns:
+    # - nil if the key did not exist.
+    # - false if the value was changed by someone else.
+    # - true if the value was successfully updated.
+    def cas(key, ttl=nil, options=nil, &block)
+      ttl ||= @options[:expires_in]
+      (value, cas) = perform(:cas, key)
+      value = (!value || value == 'Not found') ? nil : value
+      if value
+        newvalue = block.call(value)
+        perform(:set, key, newvalue, ttl, cas, options)
+      end
+    end
+
+    def set(key, value, ttl=nil, options=nil)
+      raise "Invalid API usage, please require 'dalli/memcache-client' for compatibility, see Upgrade.md" if options == true
+      ttl ||= @options[:expires_in]
+      perform(:set, key, value, ttl, 0, options)
+    end
+
+    ##
+    # Conditionally add a key/value pair, if the key does not already exist
+    # on the server.  Returns true if the operation succeeded.
+    def add(key, value, ttl=nil, options=nil)
+      ttl ||= @options[:expires_in]
+      perform(:add, key, value, ttl, options)
+    end
+
+    ##
+    # Conditionally add a key/value pair, only if the key already exists
+    # on the server.  Returns true if the operation succeeded.
+    def replace(key, value, ttl=nil, options=nil)
+      ttl ||= @options[:expires_in]
+      perform(:replace, key, value, ttl, options)
+    end
+
+    def delete(key)
+      perform(:delete, key)
+    end
+
+    ##
+    # Append value to the value already stored on the server for 'key'.
+    # Appending only works for values stored with :raw => true.
+    def append(key, value)
+      perform(:append, key, value.to_s)
+    end
+
+    ##
+    # Prepend value to the value already stored on the server for 'key'.
+    # Prepending only works for values stored with :raw => true.
+    def prepend(key, value)
+      perform(:prepend, key, value.to_s)
+    end
+
+    def flush(delay=0)
+      time = -delay
+      ring.servers.map { |s| s.request(:flush, time += delay) }
+    end
+
+    # deprecated, please use #flush.
+    alias_method :flush_all, :flush
+
+    ##
+    # Incr adds the given amount to the counter on the memcached server.
+    # Amt must be a positive value.
+    #
+    # If default is nil, the counter must already exist or the operation
+    # will fail and will return nil.  Otherwise this method will return
+    # the new value for the counter.
+    #
+    # Note that the ttl will only apply if the counter does not already
+    # exist.  To increase an existing counter and update its TTL, use
+    # #cas.
+    def incr(key, amt=1, ttl=nil, default=nil)
+      raise ArgumentError, "Positive values only: #{amt}" if amt < 0
+      ttl ||= @options[:expires_in]
+      perform(:incr, key, amt, ttl, default)
+    end
+
+    ##
+    # Decr subtracts the given amount from the counter on the memcached server.
+    # Amt must be a positive value.
+    #
+    # memcached counters are unsigned and cannot hold negative values.  Calling
+    # decr on a counter which is 0 will just return 0.
+    #
+    # If default is nil, the counter must already exist or the operation
+    # will fail and will return nil.  Otherwise this method will return
+    # the new value for the counter.
+    #
+    # Note that the ttl will only apply if the counter does not already
+    # exist.  To decrease an existing counter and update its TTL, use
+    # #cas.
+    def decr(key, amt=1, ttl=nil, default=nil)
+      raise ArgumentError, "Positive values only: #{amt}" if amt < 0
+      ttl ||= @options[:expires_in]
+      perform(:decr, key, amt, ttl, default)
+    end
+
+    ##
+    # Collect the stats for each server.
+    # Returns a hash like { 'hostname:port' => { 'stat1' => 'value1', ... }, 'hostname2:port' => { ... } }
+    def stats
+      values = {}
+      ring.servers.each do |server|
+        values["#{server.hostname}:#{server.port}"] = server.alive? ? server.request(:stats) : nil
+      end
+      values
+    end
+
+    ##
+    # Close our connection to each server.
+    # If you perform another operation after this, the connections will be re-established.
+    def close
+      if @ring
+        @ring.servers.each { |s| s.close }
+        @ring = nil
+      end
+    end
+    alias_method :reset, :close
+
+    private
+
+    def ring
+      @ring ||= Dalli::Ring.new(
+        Array(@servers).map do |s|
+          Dalli::Server.new(s, @options)
+        end, @options
+      )
+    end
+
+    def env_servers
+      ENV['MEMCACHE_SERVERS'] ? ENV['MEMCACHE_SERVERS'].split(',') : nil
+    end
+
+    # Chokepoint method for instrumentation
+    def perform(op, key, *args)
+      key = key.to_s
+      validate_key(key)
+      key = key_with_namespace(key)
+      begin
+        server = ring.server_for_key(key)
+        server.request(op, key, *args)
+      rescue NetworkError => e
+        Dalli.logger.debug { e.message }
+        Dalli.logger.debug { "retrying request with new server" }
+        retry
+      end
+    end
+
+    def validate_key(key)
+      unless !!@options[:nonascii] === true
+        raise ArgumentError, "illegal character in key #{key}" if key.respond_to?(:ascii_only?) && !key.ascii_only?
+        raise ArgumentError, "illegal character in key #{key}" if key =~ /\s/
+        raise ArgumentError, "illegal character in key #{key}" if key =~ /[\x00-\x20\x80-\xFF]/
+      end
+      raise ArgumentError, "key cannot be blank" if key.nil? || key.strip.size == 0
+      raise ArgumentError, "key too long #{key.inspect}" if key.length > 250
+    end
+
+    def key_with_namespace(key)
+      @options[:namespace] ? "#{@options[:namespace]}:#{key}" : key
+    end
+
+    def key_without_namespace(key)
+      @options[:namespace] ? key.gsub(%r(\A#{@options[:namespace]}:), '') : key
+    end
+  end
+end

data/lib/dalli/compatibility.rb

@@ -0,0 +1,52 @@
+class Dalli::Client
+
+  module MemcacheClientCompatibility
+
+    def initialize(*args)
+      Dalli.logger.error("Starting Dalli in memcache-client compatibility mode")
+      super(*args)
+    end
+
+    def set(key, value, ttl = nil, options = nil)
+      if options == true || options == false
+        Dalli.logger.error("Dalli: please use set(key, value, ttl, :raw => boolean): #{caller[0]}")
+        options = { :raw => options }
+      end
+      super(key, value, ttl, options) ? "STORED\r\n" : "NOT_STORED\r\n"
+
+    end
+
+    def add(key, value, ttl = nil, options = nil)
+      if options == true || options == false
+        Dalli.logger.error("Dalli: please use add(key, value, ttl, :raw => boolean): #{caller[0]}")
+        options = { :raw => options }
+      end
+      super(key, value, ttl, options) ? "STORED\r\n" : "NOT_STORED\r\n"
+    end
+
+    def replace(key, value, ttl = nil, options = nil)
+      if options == true || options == false
+        Dalli.logger.error("Dalli: please use replace(key, value, ttl, :raw => boolean): #{caller[0]}")
+        options = { :raw => options }
+      end
+      super(key, value, ttl, options) ? "STORED\r\n" : "NOT_STORED\r\n"
+    end
+
+    # Dalli does not unmarshall data that does not have the marshalled flag set so we need
+    # to unmarshall manually any marshalled data originally put in memcached by memcache-client.
+    # Peek at the data and see if it looks marshalled.
+    def get(key, options = nil)
+      value = super(key, options)
+      if value && value.is_a?(String) && !options && value.size > 2 &&
+              (bytes = value.unpack('cc')) && bytes[0] == 4 && bytes[1] == 8
+        return Marshal.load(value) rescue value
+      end
+      value
+    end
+
+    def delete(key)
+      super(key) ? "DELETED\r\n" : "NOT_DELETED\r\n"
+    end
+  end
+
+end

data/lib/dalli/memcache-client.rb

@@ -0,0 +1 @@
+Dalli::Client.compatibility_mode = true

data/lib/dalli/options.rb

@@ -0,0 +1,46 @@
+require 'thread'
+require 'monitor'
+
+module Dalli
+
+  # Make Dalli threadsafe by using a lock around all
+  # public server methods.
+  #
+  # Dalli::Server.extend(Dalli::Threadsafe)
+  #
+  module Threadsafe
+    def self.extended(obj)
+      obj.init_threadsafe
+    end
+
+    def request(op, *args)
+      @lock.synchronize do
+        super
+      end
+    end
+
+    def alive?
+      @lock.synchronize do
+        super
+      end
+    end
+
+    def close
+      @lock.synchronize do
+        super
+      end
+    end
+
+    def lock!
+      @lock.mon_enter
+    end
+
+    def unlock!
+      @lock.mon_exit
+    end
+
+    def init_threadsafe
+      @lock = Monitor.new
+    end
+  end
+end

data/lib/dalli/ring.rb

@@ -0,0 +1,105 @@
+require 'digest/sha1'
+require 'zlib'
+
+module Dalli
+  class Ring
+    POINTS_PER_SERVER = 160 # this is the default in libmemcached
+
+    attr_accessor :servers, :continuum
+
+    def initialize(servers, options)
+      @servers = servers
+      @continuum = nil
+      if servers.size > 1
+        total_weight = servers.inject(0) { |memo, srv| memo + srv.weight }
+        continuum = []
+        servers.each do |server|
+          entry_count_for(server, servers.size, total_weight).times do |idx|
+            hash = Digest::SHA1.hexdigest("#{server.hostname}:#{server.port}:#{idx}")
+            value = Integer("0x#{hash[0..7]}")
+            continuum << Dalli::Ring::Entry.new(value, server)
+          end
+        end
+        @continuum = continuum.sort { |a, b| a.value <=> b.value }
+      end
+
+      threadsafe! unless options[:threadsafe] == false
+      @failover = options[:failover] != false
+    end
+
+    def server_for_key(key)
+      if @continuum
+        hkey = hash_for(key)
+        20.times do |try|
+          entryidx = self.class.binary_search(@continuum, hkey)
+          server = @continuum[entryidx].server
+          return server if server.alive?
+          break unless @failover
+          hkey = hash_for("#{try}#{key}")
+        end
+      else
+        server = @servers.first
+        return server if server && server.alive?
+      end
+
+      raise Dalli::RingError, "No server available"
+    end
+
+    def lock
+      @servers.each { |s| s.lock! }
+      begin
+        return yield
+      ensure
+        @servers.each { |s| s.unlock! }
+      end
+    end
+
+    private
+
+    def threadsafe!
+      @servers.each do |s|
+        s.extend(Dalli::Threadsafe)
+      end
+    end
+
+    def hash_for(key)
+      Zlib.crc32(key)
+    end
+
+    def entry_count_for(server, total_servers, total_weight)
+      ((total_servers * POINTS_PER_SERVER * server.weight) / Float(total_weight)).floor
+    end
+
+    # Find the closest index in the Ring with value <= the given value
+    def self.binary_search(ary, value)
+      upper = ary.size - 1
+      lower = 0
+      idx = 0
+
+      while (lower <= upper) do
+        idx = (lower + upper) / 2
+        comp = ary[idx].value <=> value
+
+        if comp == 0
+          return idx
+        elsif comp > 0
+          upper = idx - 1
+        else
+          lower = idx + 1
+        end
+      end
+      return upper
+    end
+
+    class Entry
+      attr_reader :value
+      attr_reader :server
+
+      def initialize(val, srv)
+        @value = val
+        @server = srv
+      end
+    end
+
+  end
+end