localmemcache 0.2.2 → 0.3.0

data/README

@@ -1,26 +1,30 @@
 Localmemcache README
 =====================
 
-The beauty of memcached.  For local data.  Blazingly fast.
+A persistent key-value database based on mmap()'ed shared memory.
 
 * http://localmemcache.rubyforge.org/
 
 WHAT IS IT?
 ===========
 
-Localmemcache is a library for C and ruby that aims to provide an interface
-similar to memcached but for accessing local data instead of remote data.  It's
-based on mmap()'ed shared memory for maximum speed.
+Localmemcache is a library for C and ruby that aims to provide
+an interface similar to memcached but for accessing local data instead of
+remote data.  It's based on mmap()'ed shared memory for maximum speed.
+Since version 0.3.0 it supports persistence, also making it a fast
+alternative to GDBM and Berkeley DB.
 
 SUPPORTED SYSTEMS
 =================
 
-- Unix (for mmap)
-- A CPU architecture with more than 32 bits is recommended, since otherwise you
-  might run out of virtual address space when you use larger shared memory
-  segments.
-- OS X is not supported, because it doesn't have sem_timedwait() and
-  sem_getvalue().
+- a >=64bit Unix
+- a file system that offers sparse files
+
+Note for OS X: OS X disqualifies as HFS+ doesn't have sparse files and
+sem_timedwait() and sem_getvalue() aren't supported as well.
+
+Note for FreeBSD: It has been reported that Localmemcache sometimes hangs
+there, it is not yet clear what the problem is.
 
 EXAMPLE
 =======
@@ -28,7 +32,10 @@ EXAMPLE
 In Ruby:
 
 require 'localmemcache'
-$lm = LocalMemCache.new :namespace => "viewcounters"
+# 1. the memcached way
+# $lm = LocalMemCache.new :namespace => :viewcounters
+# 2. the GDBM way
+$lm = LocalMemCache.new :filename => "./viewcounters.lmc"
 $lm[:foo] = 1
 $lm[:foo]
 $lm.delete(:foo)

data/Rakefile

@@ -32,6 +32,18 @@ task :sanity_test do
       "make -C src/tests/ && ./src/tests/lmc "
 end
 
+task :performance_test do
+  sh "./configure && make -C src clean && make -C src && " +
+      "(cd src/ruby-binding; ruby extconf.rb) && " +
+      "make -C src/ruby-binding/ && " +
+      "(cd src/tests; ruby extconf.rb) && " +
+      "make -C src/tests/ && ./src/tests/lmc; " +
+      "./src/tests/bench; " +
+      "ls -al /var/tmp/localmemcache/speed-comparison.lmc && " +
+      "du -h  /var/tmp/localmemcache/speed-comparison.lmc && " +
+      "uname -a && ruby -v "
+end
+
 task :c_api_package do
   tgz = "pkg/localmemcache-#{version}.tar.gz"
   sh "test -d pkg || mkdir pkg"
@@ -42,8 +54,8 @@ end
 #task :pushsite => [:rdoc] do
 task :pushsite do
   sh "chmod 755 site"
-  sh "chmod 644 site/*.html"
-  sh "chmod 644 site/*.css"
+  sh "find site -type d | xargs chmod go+rx"
+  sh "find site -type f | xargs chmod go+r"
   sh 'rsync --rsh="ssh -i $HOME/.ssh/id_rsa_oss -l sck" -avz site/ sck@localmemcache.rubyforge.org:/var/www/gforge-projects/localmemcache/'
 end
 
@@ -62,19 +74,22 @@ else
     s.name            = "localmemcache"
     s.version         = version
     s.platform        = Gem::Platform::RUBY
-    s.summary         = "The beauty of memcached.  For local data.  " + 
-        "Blazingly fast" 
+    s.summary         = "A persistent key-value database based on mmap()'ed shared memory."
 
     s.description = <<-EOF
 
-Localmemcache aims to be faster than using memcached locally by using shared
-memory, but providing a similar interface.
+Localmemcache is a library for C and ruby that aims to provide
+an interface similar to memcached but for accessing local data instead of
+remote data.  It's based on mmap()'ed shared memory for maximum speed.
+Since version 0.3.0 it supports persistence, also making it a fast
+alternative to GDBM and Berkeley DB.
+
     EOF
 
     s.files = manifest 
     s.extensions = ['configure', 'src/ruby-binding/extconf.rb']
     s.require_path = 'src/ruby-binding'
-    s.has_rdoc = false
+    s.has_rdoc = true
     s.test_files = Dir['src/test/*.rb']
 
     s.author = 'Sven C. Koehler'

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/bench/common.rb

@@ -0,0 +1,7 @@
+def measure_time(c, &block)
+  _then = Time.now
+  c.times { block.call }
+  now = Time.now
+  puts "#{(now - _then)*1000} ms"
+end
+

data/bench/gdbm_vs_lmc

@@ -0,0 +1,10 @@
+#! /bin/sh
+D=`dirname $0`
+DIR=`cd $D; pwd`
+script=$DIR/gdbm_vs_lmc.rb
+
+if test "x$1" = "x-d"; then
+  irb -r $script
+else
+  ruby $script
+fi

data/bench/gdbm_vs_lmc.rb

@@ -0,0 +1,29 @@
+$DIR=File.dirname(__FILE__)
+['.', '../src/ruby-binding/'].each {|p| $:.unshift File.join($DIR, p) }
+
+require 'common.rb'
+
+def __test(n)
+  require 'localmemcache'
+  puts "LocalMemCache"
+  LocalMemCache.clear :filename => "/tmp/fruitstore.lmc"
+  $lm2 = LocalMemCache.new :filename=>"/tmp/fruitstore.lmc"
+  measure_time(n) {
+    r = rand(10000).to_s
+    $lm2.set(r, r)
+    $lm2.get(r)
+  }
+
+  require 'gdbm'
+  puts "GDBM"
+  h = GDBM.new("/tmp/fruitstore.db")
+  measure_time(n) {
+    r = rand(10000).to_s
+    h[r] = r
+    h[r]
+  }
+  h.close
+end
+
+__test(2_000_000)
+

data/bench/lmc_bench

@@ -0,0 +1,11 @@
+#! /bin/sh
+D=`dirname $0`
+DIR=`cd $D; pwd`
+script=$DIR/lmc_bench.rb
+
+if test "x$1" = "x-d"; then
+  irb -r $script
+else
+  #valgrind --leak-check=full --tool=memcheck ruby $script
+  ruby $script
+fi

data/bench/lmc_bench.rb

@@ -0,0 +1,27 @@
+$DIR=File.dirname(__FILE__)
+['.', '../src/ruby-binding/'].each {|p| $:.unshift File.join($DIR, p) }
+
+require 'localmemcache'
+require 'common.rb'
+
+LocalMemCache.clear_namespace("speed-comparison");
+$lm2 = LocalMemCache.new :namespace=>"speed-comparison"
+
+def compare_speed(n)
+  puts "LocalMemCache"
+  measure_time(n) {
+    r = rand(10000).to_s
+    $lm2.set(r, r)
+    $lm2.get(r)
+  }
+  
+  puts "Ruby Hash with strings"
+  $hh = {}
+  measure_time(n) {
+    r = rand(10000).to_s
+    $hh[r] = r
+    $hh[r]
+  }
+end
+
+compare_speed(2_000_000)

data/bench/memcached_bench

@@ -0,0 +1,8 @@
+#! /bin/sh
+
+/usr/bin/memcached -m 3072 -p 11211 &
+PID=$!
+
+ruby ./memcached_bench.rb
+
+kill $PID

data/bench/memcached_bench.rb

@@ -0,0 +1,19 @@
+$DIR=File.dirname(__FILE__)
+['.'].each {|p| $:.unshift File.join($DIR, p) }
+
+require 'memcache'
+require 'common.rb'
+
+def __test(n)
+  memcache_ips = ['localhost:11211'] 
+  $cache = MemCache.new memcache_ips, 
+      :namespace => 'rtn_', 
+      :multithreaded => true
+  measure_time(n) {
+    r = rand(10000).to_s
+    $cache[r] = r
+    $cache[r]
+  }
+end
+
+__test(2_000_000)

data/bench/tyrant_bench

@@ -0,0 +1,10 @@
+#! /bin/sh
+
+ttserver -port 2001 /tmp/foo.tch > /dev/null & 
+PID=$!
+
+sleep 1
+
+ruby ./tyrant_bench.rb 
+
+kill $PID

data/bench/tyrant_bench.rb

@@ -0,0 +1,19 @@
+$DIR=File.dirname(__FILE__)
+['.'].each {|p| $:.unshift File.join($DIR, p) }
+
+require 'memcache'
+require './common.rb'
+
+def __test(n)
+  memcache_ips = ['localhost:2001'] 
+  $cache = MemCache.new memcache_ips, 
+      :namespace => 'rtn_', 
+      :multithreaded => true
+  measure_time(n) {
+    r = rand(10000).to_s
+    $cache[r] = r
+    $cache[r]
+  }
+end
+
+__test(2_000_000)

data/example/hello.c

@@ -3,7 +3,7 @@
 
 int main() {
   lmc_error_t e;
-  local_memcache_t *lmc = local_memcache_create("viewcounters", 0, &e);
+  local_memcache_t *lmc = local_memcache_create("viewcounters", 0, 0, &e);
   if (!lmc) {
     fprintf(stderr, "Couldn't create localmemcache: %s\n", e.error_str);
     return 1;

data/site/doc/classes/LocalMemCache/ArgError.html

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: LocalMemCache::ArgError</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">LocalMemCache::ArgError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/__/src/ruby-binding/localmemcache_rb.html">
+                ../src/ruby-binding/localmemcache.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="LocalMemCacheError.html">
+                LocalMemCacheError
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/site/doc/classes/LocalMemCache/InitError.html

@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: LocalMemCache::InitError</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">LocalMemCache::InitError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/__/src/ruby-binding/localmemcache_rb.html">
+                ../src/ruby-binding/localmemcache.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                <a href="LocalMemCacheError.html">
+                LocalMemCacheError
+               </a>
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/site/doc/classes/LocalMemCache/LocalMemCacheError.html

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: LocalMemCache::LocalMemCacheError</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">LocalMemCache::LocalMemCacheError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/__/src/ruby-binding/localmemcache_rb.html">
+                ../src/ruby-binding/localmemcache.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                StandardError
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>