localmemcache 0.4.1 → 0.4.2

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/example/hello.c

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

data/site/doc/classes/LocalMemCache.html

@@ -58,10 +58,6 @@
                 <a href="../files/localmemcache_rb.html">
                 localmemcache.rb
                 </a>
-        <br />
-                <a href="../files/rblocalmemcache_c.html">
-                rblocalmemcache.c
-                </a>
         <br />
             </td>
         </tr>
@@ -82,63 +78,6 @@
 
   <div id="contextContent">
 
-    <div id="description">
-      <p>
-<tt><a href="LocalMemCache.html">LocalMemCache</a></tt> provides for a
-Hashtable of strings in shared memory (via a memory mapped file), which
-thus can be shared between processes on a computer. Here is an example of
-its usage:
-</p>
-<pre>
-  $lm = LocalMemCache.new :namespace =&gt; &quot;viewcounters&quot;
-  $lm[:foo] = 1
-  $lm[:foo]          # -&gt; &quot;1&quot;
-  $lm.delete(:foo)
-</pre>
-<p>
-<tt><a href="LocalMemCache.html">LocalMemCache</a></tt> can also be used as
-a persistent key value database, just use the :filename instead of the
-:namespace parameter.
-</p>
-<pre>
-  $lm = LocalMemCache.new :filename =&gt; &quot;my-database.lmc&quot;
-  $lm[:foo] = 1
-  $lm[:foo]          # -&gt; &quot;1&quot;
-  $lm.delete(:foo)
-
- == Default sizes of memory pools
-
- The default size for memory pools is 1024 (MB). It cannot be changed later,
- so choose a size that will provide enough space for all your data.  You
- might consider setting this size to the maximum filesize of your
- filesystem.  Also note that while these memory pools may look large on your
- disk, they really aren't, because with sparse files only those parts of the
- file which contain non-null data actually use disk space.
-
- == Automatic recovery from crashes
-
- In case a process is terminated while accessing a memory pool, other
- processes will wait for the lock up to 2 seconds, and will then try to
- resume the aborted operation.  This can also be done explicitly by using
- LocalMemCache.check(options).
-
- == Clearing memory pools
-
- Removing memory pools can be done with LocalMemCache.drop(options).
-
- == Environment
-
- If you use the :namespace parameter, the .lmc file for your namespace will
- reside in /var/tmp/localmemcache.  This can be overriden by setting the
- LMC_NAMESPACES_ROOT_PATH variable in the environment.
-
- == Storing Ruby Objects
-
- If you want to store Ruby objects instead of just strings, consider
- using LocalMemCache::SharedObjectStorage.
-</pre>
-
-    </div>
 
 
    </div>
@@ -147,20 +86,7 @@ a persistent key value database, just use the :filename instead of the
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000005">[]</a>&nbsp;&nbsp;
-      <a href="#M000009">[]=</a>&nbsp;&nbsp;
-      <a href="#M000003">check</a>&nbsp;&nbsp;
-      <a href="#M000008">clear</a>&nbsp;&nbsp;
-      <a href="#M000013">close</a>&nbsp;&nbsp;
-      <a href="#M000006">delete</a>&nbsp;&nbsp;
-      <a href="#M000002">drop</a>&nbsp;&nbsp;
-      <a href="#M000011">each_pair</a>&nbsp;&nbsp;
-      <a href="#M000004">get</a>&nbsp;&nbsp;
-      <a href="#M000010">keys</a>&nbsp;&nbsp;
       <a href="#M000001">new</a>&nbsp;&nbsp;
-      <a href="#M000012">random_pair</a>&nbsp;&nbsp;
-      <a href="#M000007">set</a>&nbsp;&nbsp;
-      <a href="#M000014">size</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -201,73 +127,6 @@ Class <a href="LocalMemCache/ShmUnlockFailed.html" class="link">LocalMemCache::S
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000003.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000003.html');return false;">
-          <span class="method-name"> LocalMemCache.check(*args)<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Tries to repair a corrupt namespace. Usually one doesn&#8216;t call this
-method directly, it&#8216;s invoked automatically when operations time out.
-</p>
-<p>
-valid options are [:namespace] [:filename]
-</p>
-<p>
-The memory pool must be specified by either setting the :filename or
-:namespace option.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000002.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000002.html');return false;">
-          <span class="method-name"> LocalMemCache.drop(*args)<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Deletes a memory pool. If the :force option is <a
-href="LocalMemCache.html#M000007">set</a>, locked semaphores are removed as
-well.
-</p>
-<p>
-WARNING: Do only call this method with the :force option if you are sure
-that you really want to remove this memory pool and no more processes are
-still using it.
-</p>
-<p>
-If you <a href="LocalMemCache.html#M000006">delete</a> a pool and other
-processes still have handles open on it, the status of these handles
-becomes undefined. There&#8216;s no way for a process to know when a handle
-is not valid anymore, so only <a
-href="LocalMemCache.html#M000006">delete</a> a memory pool if you are sure
-that all handles are closed.
-</p>
-<p>
-valid options for <a href="LocalMemCache.html#M000002">drop</a> are
-[:namespace] [:filename] [:force]
-</p>
-<p>
-The memory pool must be specified by either setting the :filename or
-:namespace option. The default for :force is false.
-</p>
-        </div>
-      </div>
-
       <div id="method-M000001" class="method-detail">
         <a name="M000001"></a>
 
@@ -289,13 +148,28 @@ a shared memory region.
 </p>
 <p>
 <a href="LocalMemCache.html#M000001">LocalMemCache.new</a>
+:namespace=&gt;&quot;foo&quot;, :size_mb=&gt; 1, :min_alloc_size =&gt; 256
+</p>
+<p>
+<a href="LocalMemCache.html#M000001">LocalMemCache.new</a>
 :filename=&gt;&quot;./foo.lmc&quot;
 </p>
 <p>
+<a href="LocalMemCache.html#M000001">LocalMemCache.new</a>
+:filename=&gt;&quot;./foo.lmc&quot;, :min_alloc_size =&gt; 512
+</p>
+<p>
 You must supply at least a :namespace or :filename parameter The size_mb
 defaults to 1024 (1 GB).
 </p>
 <p>
+The :min_alloc_size parameter was introduced to help with use cases that
+intend to use a hash table with growing values. This is currently not
+handled well by the internal allocator as it will end up with a large list
+of unusable free blocks. By setting the :min_alloc_size parameter you help
+the allocator to plan better ahead.
+</p>
+<p>
 If you use the :namespace parameter, the .lmc file for your namespace will
 reside in /var/tmp/localmemcache. This can be overriden by setting the
 LMC_NAMESPACES_ROOT_PATH variable in the environment.
@@ -304,215 +178,10 @@ LMC_NAMESPACES_ROOT_PATH variable in the environment.
 When you first call .<a href="LocalMemCache.html#M000001">new</a> for a
 previously not existing memory pool, a sparse file will be created and
 memory and disk space will be allocated to hold the empty hashtable (about
-100K), so the size_mb refers only to the maximum <a
-href="LocalMemCache.html#M000014">size</a> of the memory pool. .<a
-href="LocalMemCache.html#M000001">new</a> for an already existing memory
-pool will only map the already previously allocated RAM into the virtual
-address space of your process.
-</p>
-        </div>
-      </div>
-
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000005.html');return false;">
-          <span class="method-name">lmc.get(key)   &rarr;   string value or nil<br />
-lmc[key]       &rarr;   string value or nil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Retrieve string value from hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000009.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000009.html');return false;">
-          <span class="method-name">lmc.set(key, value)   &rarr;   Qnil<br />
-lmc[key]=value        &rarr;   Qnil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Set value for key in hashtable. Value and key will be converted to string.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000008.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000008.html');return false;">
-          <span class="method-name">lmc.clear &rarr; Qnil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Clears content of hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000013.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000013.html');return false;">
-          <span class="method-name">lmc.close()   &rarr;   Qnil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Releases hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000006.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000006.html');return false;">
-          <span class="method-name">lmc.delete(key)   &rarr;   Qnil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Deletes key from hashtable. The key is converted to string.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000011.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000011.html');return false;">
-          <span class="method-name">lmc.each_pair {|k, v|  block } &rarr; nil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Iterates over hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000004.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000004.html');return false;">
-          <span class="method-name">lmc.get(key)   &rarr;   string value or nil<br />
-lmc[key]       &rarr;   string value or nil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Retrieve string value from hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000010.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000010.html');return false;">
-          <span class="method-name">lmc.keys()   &rarr;   array or nil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns a list of <a href="LocalMemCache.html#M000010">keys</a>.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000012.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000012.html');return false;">
-          <span class="method-name">lmc.random_pair()   &rarr;  [key, value] or nil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Retrieves random pair from hashtable.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000007.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000007.html');return false;">
-          <span class="method-name">lmc.set(key, value)   &rarr;   Qnil<br />
-lmc[key]=value        &rarr;   Qnil<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Set value for key in hashtable. Value and key will be converted to string.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000014" class="method-detail">
-        <a name="M000014"></a>
-
-        <div class="method-heading">
-          <a href="LocalMemCache.src/M000014.html" target="Code" class="method-signature"
-            onclick="popupCode('LocalMemCache.src/M000014.html');return false;">
-          <span class="method-name">lmc.size &rarr; number<br />
-</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Number of pairs in the hashtable.
+100K), so the size_mb refers only to the maximum size of the memory pool.
+.<a href="LocalMemCache.html#M000001">new</a> for an already existing
+memory pool will only map the already previously allocated RAM into the
+virtual address space of your process.
 </p>
         </div>
       </div>

data/site/doc/classes/LocalMemCache.src/M000001.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 40</span>
+  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 52</span>
   <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>)
     <span class="ruby-identifier">o</span> = { <span class="ruby-identifier">:size_mb</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span> }.<span class="ruby-identifier">update</span>(<span class="ruby-identifier">options</span> <span class="ruby-operator">||</span> {})
     <span class="ruby-identifier">_new</span>(<span class="ruby-identifier">o</span>);

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

@@ -97,10 +97,10 @@ strings for the keys, though).
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000016">[]</a>&nbsp;&nbsp;
-      <a href="#M000015">[]=</a>&nbsp;&nbsp;
-      <a href="#M000017">each_pair</a>&nbsp;&nbsp;
-      <a href="#M000018">random_pair</a>&nbsp;&nbsp;
+      <a href="#M000003">[]</a>&nbsp;&nbsp;
+      <a href="#M000002">[]=</a>&nbsp;&nbsp;
+      <a href="#M000004">each_pair</a>&nbsp;&nbsp;
+      <a href="#M000005">random_pair</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -122,12 +122,12 @@ strings for the keys, though).
     <div id="methods">
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000016" class="method-detail">
-        <a name="M000016"></a>
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
 
         <div class="method-heading">
-          <a href="SharedObjectStorage.src/M000016.html" target="Code" class="method-signature"
-            onclick="popupCode('SharedObjectStorage.src/M000016.html');return false;">
+          <a href="SharedObjectStorage.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('SharedObjectStorage.src/M000003.html');return false;">
           <span class="method-name">[]</span><span class="method-args">(key)</span>
           </a>
         </div>
@@ -136,12 +136,12 @@ strings for the keys, though).
         </div>
       </div>
 
-      <div id="method-M000015" class="method-detail">
-        <a name="M000015"></a>
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
 
         <div class="method-heading">
-          <a href="SharedObjectStorage.src/M000015.html" target="Code" class="method-signature"
-            onclick="popupCode('SharedObjectStorage.src/M000015.html');return false;">
+          <a href="SharedObjectStorage.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('SharedObjectStorage.src/M000002.html');return false;">
           <span class="method-name">[]=</span><span class="method-args">(key,val)</span>
           </a>
         </div>
@@ -150,12 +150,12 @@ strings for the keys, though).
         </div>
       </div>
 
-      <div id="method-M000017" class="method-detail">
-        <a name="M000017"></a>
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
 
         <div class="method-heading">
-          <a href="SharedObjectStorage.src/M000017.html" target="Code" class="method-signature"
-            onclick="popupCode('SharedObjectStorage.src/M000017.html');return false;">
+          <a href="SharedObjectStorage.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('SharedObjectStorage.src/M000004.html');return false;">
           <span class="method-name">each_pair</span><span class="method-args">(&amp;block)</span>
           </a>
         </div>
@@ -164,12 +164,12 @@ strings for the keys, though).
         </div>
       </div>
 
-      <div id="method-M000018" class="method-detail">
-        <a name="M000018"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="SharedObjectStorage.src/M000018.html" target="Code" class="method-signature"
-            onclick="popupCode('SharedObjectStorage.src/M000018.html');return false;">
+          <a href="SharedObjectStorage.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('SharedObjectStorage.src/M000005.html');return false;">
           <span class="method-name">random_pair</span><span class="method-args">()</span>
           </a>
         </div>

data/site/doc/classes/LocalMemCache/SharedObjectStorage.src/M000015.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 49</span>
+  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 57</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]=</span>(<span class="ruby-identifier">key</span>,<span class="ruby-identifier">val</span>) <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">key</span>, <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">val</span>)) <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/site/doc/classes/LocalMemCache/SharedObjectStorage.src/M000016.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 50</span>
+  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 58</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-operator">[]</span>(<span class="ruby-identifier">key</span>) <span class="ruby-identifier">v</span> = <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">key</span>); <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">v</span>) <span class="ruby-keyword kw">end</span></pre>
 </body>
 </html>

data/site/doc/classes/LocalMemCache/SharedObjectStorage.src/M000017.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 51</span>
+  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 59</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">each_pair</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>) 
       <span class="ruby-keyword kw">super</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">mv</span><span class="ruby-operator">|</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">k</span>, <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">mv</span>)) }
     <span class="ruby-keyword kw">end</span></pre>

data/site/doc/classes/LocalMemCache/SharedObjectStorage.src/M000018.html

@@ -10,7 +10,7 @@
   <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
 </head>
 <body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 54</span>
+  <pre><span class="ruby-comment cmt"># File localmemcache.rb, line 62</span>
     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">random_pair</span>
       <span class="ruby-identifier">rp</span> = <span class="ruby-keyword kw">super</span>
       <span class="ruby-identifier">rp</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">nil</span> <span class="ruby-operator">:</span> [<span class="ruby-identifier">rp</span>.<span class="ruby-identifier">first</span>, <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">rp</span>.<span class="ruby-identifier">last</span>)]

data/site/doc/created.rid

@@ -1 +1 @@
-Wed, 06 May 2009 09:55:58 +0000
+Mon, 10 Aug 2009 14:36:31 +0000

data/site/doc/files/extconf_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Sun Apr 05 12:31:31 +0000 2009</td>
+      <td>Sun Aug 09 13:38:34 +0000 2009</td>
     </tr>
     </table>
   </div>

data/site/doc/files/localmemcache_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed May 06 09:25:52 +0000 2009</td>
+      <td>Mon Aug 10 14:36:12 +0000 2009</td>
     </tr>
     </table>
   </div>

data/site/doc/files/rblocalmemcache_c.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Wed May 06 09:29:40 +0000 2009</td>
+      <td>Sun Aug 09 22:37:43 +0000 2009</td>
     </tr>
     </table>
   </div>

data/site/doc/fr_file_index.html

@@ -20,9 +20,7 @@
 <div id="index">
   <h1 class="section-bar">Files</h1>
   <div id="index-entries">
-    <a href="files/extconf_rb.html">extconf.rb</a><br />
     <a href="files/localmemcache_rb.html">localmemcache.rb</a><br />
-    <a href="files/rblocalmemcache_c.html">rblocalmemcache.c</a><br />
   </div>
 </div>
 </body>

data/site/doc/fr_method_index.html

@@ -20,24 +20,11 @@
 <div id="index">
   <h1 class="section-bar">Methods</h1>
   <div id="index-entries">
-    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000016">[] (LocalMemCache::SharedObjectStorage)</a><br />
-    <a href="classes/LocalMemCache.html#M000005">[] (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000009">[]= (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000015">[]= (LocalMemCache::SharedObjectStorage)</a><br />
-    <a href="classes/LocalMemCache.html#M000003">check (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000008">clear (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000013">close (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000006">delete (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000002">drop (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000011">each_pair (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000017">each_pair (LocalMemCache::SharedObjectStorage)</a><br />
-    <a href="classes/LocalMemCache.html#M000004">get (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000010">keys (LocalMemCache)</a><br />
+    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000003">[] (LocalMemCache::SharedObjectStorage)</a><br />
+    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000002">[]= (LocalMemCache::SharedObjectStorage)</a><br />
+    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000004">each_pair (LocalMemCache::SharedObjectStorage)</a><br />
     <a href="classes/LocalMemCache.html#M000001">new (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000012">random_pair (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000018">random_pair (LocalMemCache::SharedObjectStorage)</a><br />
-    <a href="classes/LocalMemCache.html#M000007">set (LocalMemCache)</a><br />
-    <a href="classes/LocalMemCache.html#M000014">size (LocalMemCache)</a><br />
+    <a href="classes/LocalMemCache/SharedObjectStorage.html#M000005">random_pair (LocalMemCache::SharedObjectStorage)</a><br />
   </div>
 </div>
 </body>

data/site/index.html

@@ -17,6 +17,16 @@ speed</b>.
 Since version 0.3.0 it supports <b>persistence</b>, also making it <b>a fast
 alternative to GDBM, Berkeley DB, and Tokyo Cabinet</b>.
 
+<h2>Version 0.4.2: Improving Append Performance (2009-08-10)</h2>
+
+In 0.4.2 the <b>:min_alloc_size</b> parameter was introduced to help with use
+cases that intend to use a hash table with growing values. This is
+currently not handled well by the internal allocator as it will end up
+with a large list of unusable free blocks. By setting the
+<b>:min_alloc_size</b> parameter you help the allocator to plan better
+ahead. (<a href="http://localmemcache.rubyforge.org/doc/classes/LocalMemCache.html#M000001">more</a>)
+
+
 <h2>Key features as of 0.4.0 (2009-05-16)</h2>
 <li><a href="#performance">blazingly fast</a></li>
 <li>a very simple API</li>
@@ -45,7 +55,7 @@ sometimes hangs there, it is not yet clear what the problem is.
 If you just want to use the <b>C API</b>, download the .tar.gz from <a href="http://rubyforge.org/frs/?group_id=7925">here</a>.
 
 <h2>Using</h2>
-<b>API</b>:&nbsp;<a href="http://github.com/sck/localmemcache/blob/591d943507236035e99471f372dc2826271610c9/src/localmemcache.h">C</a>|<a href="http://localmemcache.rubyforge.org/doc/">Ruby</a><br>
+<b>API</b>:&nbsp;<a href="http://github.com/sck/localmemcache/blob/d72a5bd825b0fb573f1048ea9cae92d8c143525c/src/localmemcache.h">C</a>|<a href="http://localmemcache.rubyforge.org/doc/">Ruby</a><br>
 <p><pre><code>require 'localmemcache'
 # 1. the memcached way
 # $lm = LocalMemCache.new :namespace => :viewcounters
@@ -59,7 +69,7 @@ $lm[:foo]
 $lm.delete(:foo)
 
 </code></pre> 
-(C version of this example: <a href="http://github.com/sck/localmemcache/blob/e980ba949034a349dbf0e6f8f9ef77bbe3e3e314/example/hello.c">hello.c</a>)
+(C version of this example: <a href="http://github.com/sck/localmemcache/blob/d72a5bd825b0fb573f1048ea9cae92d8c143525c/example/hello.c">hello.c</a>)
 </p>
 
 <a name="performance" id="performance"></a>
@@ -99,7 +109,13 @@ can be retrieved by executing</p>
 <pre><code>git clone git://github.com/sck/localmemcache.git
 </code></pre>
 
-<h2>Tips for backups</h1>
+<h2>Who uses Localmemcache?</h2>
+
+<a href="http://www.personifi.com">Personifi</a> use Localmemcache to
+serve billions of hits each month.  Armin Roehrl: "we use
+localmemcache because it solves one problem very well and we love it!"
+
+<h2>Tips for backups</h2>
 
 Note that you cannot copy Localmemcache's .lmc files while other
 processes are making changes to the data, this will likely result in a

data/src/lmc_common.h

@@ -5,7 +5,7 @@
 #ifndef _LMC_COMMON_H_INCLUDED_
 #define _LMC_COMMON_H_INCLUDED_
 
-#define LMC_DB_VERSION 1
+#define LMC_DB_VERSION 2
 
 extern int lmc_test_crash_enabled;
 #ifdef DO_TEST_CRASH

data/src/lmc_valloc.c

@@ -52,6 +52,32 @@ void lmc_dump(void *base) {
   }
 }
 
+size_t lmc_min_alloc_size(void *base) {
+  lmc_mem_descriptor_t *md = base;
+  return md->version > 1 ? md->min_alloc_size : 0;
+}
+
+/*
+ * Thanks to: http://graphics.stanford.edu/~seander/bithacks.html#RoundUpPowerOf2
+ */
+size_t round_to_next_power_of_2(size_t v) {
+  v--;
+  v |= v >> 1;
+  v |= v >> 2;
+  v |= v >> 4;
+  v |= v >> 8;
+  v |= v >> 16;
+  //v |= v >> 32;
+  v++;
+  return v;
+}
+
+void lmc_set_min_alloc_size(void *base, size_t s) {
+  lmc_mem_descriptor_t *md = base;
+  if (md->version < 2) { return; }
+  md->min_alloc_size = round_to_next_power_of_2(s);
+}
+
 int lmc_is_va_valid(void *base, size_t va) {
   lmc_mem_descriptor_t *md = base;
   lmc_mem_chunk_descriptor_t* c = base + va;
@@ -140,9 +166,9 @@ size_t __s(char *where, lmc_mem_status_t ms, size_t mem_before, size_t expected_
 
 size_t lmc_valloc(void *base, size_t size) {
   lmc_mem_descriptor_t *md = base;
-  // consider: make size divisible by power of 2
   size_t s = lmc_max(size + sizeof(size_t), 
       sizeof(lmc_mem_chunk_descriptor_t) + sizeof(size_t));
+  s = lmc_max(lmc_min_alloc_size(base), round_to_next_power_of_2(s));
   lmc_mem_chunk_descriptor_t *c = md_first_free(base);
   lmc_mem_chunk_descriptor_t *p = NULL;
   if (size == 0) { return 0; }

data/src/lmc_valloc.h

@@ -21,13 +21,14 @@ typedef struct {
 
 typedef struct {
   size_t first_free;
-  size_t dummy2;
+  size_t dummy2;  // dummy for next
   size_t total_size;
   size_t magic;
   size_t va_hash;
   int locked;
   size_t version;
   lmc_log_descriptor_t log;
+  size_t min_alloc_size;
 } lmc_mem_descriptor_t;
 
 typedef struct {
@@ -49,5 +50,6 @@ int lmc_um_find_leaks(void *base, char *bf);
 
 lmc_log_descriptor_t *lmc_log_op(void *base, int opid);
 void lmc_log_finish(void *base);
+void lmc_set_min_alloc_size(void *base, size_t s);
 
 #endif

data/src/localmemcache.c

@@ -20,6 +20,7 @@ int lmc_set_lock_flag(void *base, lmc_error_t *e) {
   return 1;
 }
 
+
 int lmc_release_lock_flag(void *base, lmc_error_t *e) {
   lmc_mem_descriptor_t *md = base;
   if (md->locked != 1) {
@@ -78,7 +79,7 @@ int local_memcache_drop_namespace(const char *namespace, const char *filename,
 int __local_memcache_check_namespace(const char *clean_ns, lmc_error_t *e);
 
 local_memcache_t *__local_memcache_create(const char *namespace, size_t size, 
-    int force, int *ok, lmc_error_t* e) {
+    long min_alloc_size, int force, int *ok, lmc_error_t* e) {
   int d;
   if (!ok) { ok = &d; }
   *ok = 1;
@@ -114,7 +115,7 @@ retry:
         if (!force)  goto release_and_fail;
         *ok = 0;
       }
-      if (lmc_get_db_version(lmc->base) != LMC_DB_VERSION) {
+      if (lmc_get_db_version(lmc->base) > LMC_DB_VERSION) {
         lmc_handle_error_with_err_string("local_memcache_create",
             "DB version is incompatible", "DBVersionNotSupported", e);
         goto unlock_and_fail;
@@ -129,6 +130,7 @@ retry:
       lmc->va_hash = md->va_hash;
     }
     if (*ok) { 
+      lmc_set_min_alloc_size(lmc->base, min_alloc_size);
       lmc_release_lock_flag(lmc->base, e);
       lmc_lock_release("local_memcache_create", lmc->lock, e); 
     }
@@ -146,14 +148,15 @@ failed:
 }
 
 local_memcache_t *local_memcache_create(const char *namespace, 
-    const char *filename, double size_mb, lmc_error_t* e) {  
+    const char *filename, double size_mb, size_t min_alloc_size, 
+    lmc_error_t* e) {  
   char clean_ns[1024];
   double s = size_mb == 0.0 ? 1024.0 : size_mb;
   size_t si = s * 1024 * 1024;
   //printf("size: %f, s: %f, si: %zd\n", size_mb, s, si);
   if (!lmc_namespace_or_filename((char *)clean_ns, namespace, filename, e))
       return 0;
-  return __local_memcache_create((char *)clean_ns, si, 0, 0, e);
+  return __local_memcache_create((char *)clean_ns, si, min_alloc_size, 0, 0, e);
 }
 
 int __local_memcache_check_namespace(const char *clean_ns, lmc_error_t *e) {
@@ -180,7 +183,7 @@ int __local_memcache_check_namespace(const char *clean_ns, lmc_error_t *e) {
   size_t ns_size = lmc_namespace_size((char *)clean_ns);
   int ok;
   local_memcache_t *lmc = __local_memcache_create((char *)clean_ns, ns_size, 
-      1, &ok, e);
+      0, 1, &ok, e);
   if (!lmc) {
     lmc_handle_error_with_err_string("__local_memcache_create", 
         "Unable to attach memory pool", "InitError", e);

data/src/localmemcache.h

@@ -95,14 +95,22 @@ typedef struct {
  * 
  *  lmc_error_t e;
  *  // open via namespace
- *  local_memcache_t *lmc = local_memcache_create("viewcounters", 0, 0, &e);
+ *  local_memcache_t *lmc = local_memcache_create("viewcounters", 0, 0, 0, &e);
  *  // open via filename
- *  local_memcache_t *lmc = local_memcache_create(0, "./foo.lmc", 0, &e);
+ *  local_memcache_t *lmc = local_memcache_create(0, "./foo.lmc", 0, 0, &e);
+ *  // open via filename + min_alloc_size set
+ *  local_memcache_t *lmc = local_memcache_create(0, "./foo.lmc", 0, 1024, &e);
  * 
  *  You must supply at least a namespace or filename parameter
  *
  *  The size_mb defaults to 1024 (1 GB).
  *
+ *  The min_alloc_size parameter was introduced to help with use cases that
+ *  intend to use a hash table with growing values.  This is currently not
+ *  handled well by the internal allocator as it will end up with a large list
+ *  of unusable free blocks.  By setting the min_alloc_size parameter you help
+ *  the allocator to plan better ahead.
+ *
  *  If you use the namespace parameter, the .lmc file for your namespace will
  *  reside in /var/tmp/localmemcache.  This can be overriden by setting the
  *  LMC_NAMESPACES_ROOT_PATH variable in the environment.
@@ -115,7 +123,8 @@ typedef struct {
  *  virtual address space of your process.  
  */
 local_memcache_t *local_memcache_create(const char *namespace, 
-    const char *filename, double size_mb, lmc_error_t* e);
+    const char *filename, double size_mb, size_t min_alloc_size, 
+    lmc_error_t* e);
 
 /* 
  *  Retrieve string value from hashtable.

data/src/ruby-binding/localmemcache.rb

@@ -19,12 +19,24 @@ class LocalMemCache
   #  Creates a new handle for accessing a shared memory region.
   # 
   #  LocalMemCache.new :namespace=>"foo", :size_mb=> 1
+  #
+  #  LocalMemCache.new :namespace=>"foo", :size_mb=> 1, :min_alloc_size => 256
+  #
+  #
   # 
   #  LocalMemCache.new :filename=>"./foo.lmc"
+  #
+  #  LocalMemCache.new :filename=>"./foo.lmc", :min_alloc_size => 512
   # 
   #  You must supply at least a :namespace or :filename parameter
   #  The size_mb defaults to 1024 (1 GB).
   #
+  #  The :min_alloc_size parameter was introduced to help with use cases that
+  #  intend to use a hash table with growing values.  This is currently not
+  #  handled well by the internal allocator as it will end up with a large list
+  #  of unusable free blocks.  By setting the :min_alloc_size parameter you
+  #  help the allocator to plan better ahead.
+  #
   #  If you use the :namespace parameter, the .lmc file for your namespace will
   #  reside in /var/tmp/localmemcache.  This can be overriden by setting the
   #  LMC_NAMESPACES_ROOT_PATH variable in the environment.

data/src/ruby-binding/rblocalmemcache.c

@@ -75,6 +75,7 @@ static VALUE LocalMemCache;
 static VALUE lmc_rb_sym_namespace;
 static VALUE lmc_rb_sym_filename;
 static VALUE lmc_rb_sym_size_mb;
+static VALUE lmc_rb_sym_min_alloc_size;
 static VALUE lmc_rb_sym_force;
 
 /* :nodoc: */
@@ -118,7 +119,8 @@ static VALUE LocalMemCache__new2(VALUE klass, VALUE o) {
   local_memcache_t *l = local_memcache_create(
       rstring_ptr_null(rb_hash_aref(o, lmc_rb_sym_namespace)),
       rstring_ptr_null(rb_hash_aref(o, lmc_rb_sym_filename)), 
-      double_value(rb_hash_aref(o, lmc_rb_sym_size_mb)), &e);
+      double_value(rb_hash_aref(o, lmc_rb_sym_size_mb)),
+      long_value(rb_hash_aref(o, lmc_rb_sym_min_alloc_size)), &e);
   if (!l)  rb_lmc_raise_exception(&e);
   rb_lmc_handle_t *h = calloc(1, sizeof(rb_lmc_handle_t));
   if (!h) rb_raise(rb_eRuntimeError, "memory allocation error");
@@ -489,6 +491,7 @@ void Init_rblocalmemcache() {
   lmc_rb_sym_namespace = ID2SYM(rb_intern("namespace"));
   lmc_rb_sym_filename = ID2SYM(rb_intern("filename"));
   lmc_rb_sym_size_mb = ID2SYM(rb_intern("size_mb"));
+  lmc_rb_sym_min_alloc_size = ID2SYM(rb_intern("min_alloc_size"));
   lmc_rb_sym_force = ID2SYM(rb_intern("force"));
   rb_require("localmemcache.rb");
 }

data/src/tests/bench-append

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

data/src/tests/bench-append.rb

@@ -0,0 +1,61 @@
+$DIR=File.dirname(__FILE__)
+['.', '..', '../ruby-binding/'].each {|p| $:.unshift File.join($DIR, p) }
+
+require 'bacon'
+require 'localmemcache'
+
+Bacon.summary_on_exit
+
+LocalMemCache.drop :namespace => "speed-comparison", :force => true
+$lm2 = LocalMemCache.new :namespace=>"speed-comparison", :min_alloc_size => 1024
+
+def compare_speed(n)
+  
+  puts "LocalMemCache"
+  measure_time(n) {
+    r = rand(10000).to_s
+    v = $lm2.get(r)
+    $lm2.set(r, "#{v}#{r}")
+  }
+  
+  puts "Ruby Hash of Strings"
+  $hh = {}
+  measure_time(n) {
+    r = rand(10000).to_s
+    v = $hh[r]
+    $hh[r] = "#{v}#{r}"
+  }
+end
+
+def test_gdbm(n)
+  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
+
+
+def measure_time(c, &block)
+  _then = Time.now
+  c.times { block.call }
+  now = Time.now
+  puts "#{(now - _then)*1000} ms"
+end
+
+compare_speed(200_000)
+#test_gdbm(2_000_000)
+
+#$stdout.write "ht shm setting x 20000: "
+#tmeasure (2_000_000) { 
+#  v = $lm2.get("f").to_i + 1
+#  #puts "v:#{v}"
+#  $lm2.set("f", v) 
+#}
+#puts "foo: #{$lm2.get("f")}"
+ 

data/src/tests/lmc.rb

@@ -10,7 +10,7 @@ LocalMemCache.drop :namespace => "test", :force => true
 $lm = LocalMemCache.new :namespace=>"test", :size_mb => 20
 
 LocalMemCache.drop :namespace => "test-small", :force => true
-$lms = LocalMemCache.new :namespace=>"test-small", :size_mb => 0.20;
+$lms = LocalMemCache.new :namespace=>"test-small", :size_mb => 1;
 
 describe 'LocalMemCache' do
 
@@ -72,7 +72,7 @@ describe 'LocalMemCache' do
 
   it 'should support size' do
     LocalMemCache.drop :namespace =>"size-test", :force=>true
-    ll = LocalMemCache.new :namespace => "size-test", :size_mb => 0.2
+    ll = LocalMemCache.new :namespace => "size-test", :size_mb => 1
     ll.size.should.equal 0
     ll[:one] = 1
     ll.size.should.equal 1
@@ -98,7 +98,7 @@ describe 'LocalMemCache' do
 
   it 'should support filename parameters' do
     LocalMemCache.drop :filename => ".tmp.a.lmc", :force => true
-    lm = LocalMemCache.new :filename => ".tmp.a.lmc", :size_mb => 0.20
+    lm = LocalMemCache.new :filename => ".tmp.a.lmc", :size_mb => 1
     lm[:boo] = 1
     lm.size.should.equal 1
     File.exists?(".tmp.a.lmc").should.be.true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: localmemcache
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Sven C. Koehler
@@ -9,11 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-02 00:00:00 +00:00
+date: 2009-08-10 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
-description: 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.
+description: |+
+  
+  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.
+  
 email: schween@snafu.de
 executables: []
 
@@ -119,6 +126,8 @@ files:
 - src/tests/allocfailure.rb
 - src/tests/bacon.rb
 - src/tests/bench
+- src/tests/bench-append
+- src/tests/bench-append.rb
 - src/tests/bench.rb
 - src/tests/bench_keys
 - src/tests/bench_keys.rb
@@ -144,6 +153,8 @@ files:
 - src/tests/ttrandom_pair.rb
 has_rdoc: true
 homepage: http://localmemcache.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -164,9 +175,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: localmemcache
-rubygems_version: 1.2.0
+rubygems_version: 1.3.3
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A persistent key-value database based on mmap()'ed shared memory.
 test_files: []