fixes #172 Moved memarena to util, made its public API more consistent with

the rest of the code

3 files changed, 400 insertions, 0 deletions

diff --git a/util/CMakeLists.txt b/util/CMakeLists.txt
index 89315100fec..6a0bb6208a5 100644
--- a/util/CMakeLists.txt
+++ b/util/CMakeLists.txt
@@ -2,6 +2,7 @@ set(util_srcs
   context
   frwlock
   kibbutz
+  memarena
   mempool
   partitioned_counter
   threadpool
diff --git a/util/memarena.cc b/util/memarena.cc
new file mode 100644
index 00000000000..d37c3c56e25
--- /dev/null
+++ b/util/memarena.cc
@@ -0,0 +1,263 @@
+/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+// vim: ft=cpp:expandtab:ts=8:sw=4:softtabstop=4:
+#ident "$Id$"
+/*
+COPYING CONDITIONS NOTICE:
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of version 2 of the GNU General Public License as
+  published by the Free Software Foundation, and provided that the
+  following conditions are met:
+
+      * Redistributions of source code must retain this COPYING
+        CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
+        DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
+        PATENT MARKING NOTICE (below), and the PATENT RIGHTS
+        GRANT (below).
+
+      * Redistributions in binary form must reproduce this COPYING
+        CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
+        DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
+        PATENT MARKING NOTICE (below), and the PATENT RIGHTS
+        GRANT (below) in the documentation and/or other materials
+        provided with the distribution.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+  02110-1301, USA.
+
+COPYRIGHT NOTICE:
+
+  TokuDB, Tokutek Fractal Tree Indexing Library.
+  Copyright (C) 2007-2013 Tokutek, Inc.
+
+DISCLAIMER:
+
+  This program is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  General Public License for more details.
+
+UNIVERSITY PATENT NOTICE:
+
+  The technology is licensed by the Massachusetts Institute of
+  Technology, Rutgers State University of New Jersey, and the Research
+  Foundation of State University of New York at Stony Brook under
+  United States of America Serial No. 11/760379 and to the patents
+  and/or patent applications resulting from it.
+
+PATENT MARKING NOTICE:
+
+  This software is covered by US Patent No. 8,185,551.
+  This software is covered by US Patent No. 8,489,638.
+
+PATENT RIGHTS GRANT:
+
+  "THIS IMPLEMENTATION" means the copyrightable works distributed by
+  Tokutek as part of the Fractal Tree project.
+
+  "PATENT CLAIMS" means the claims of patents that are owned or
+  licensable by Tokutek, both currently or in the future; and that in
+  the absence of this license would be infringed by THIS
+  IMPLEMENTATION or by using or running THIS IMPLEMENTATION.
+
+  "PATENT CHALLENGE" shall mean a challenge to the validity,
+  patentability, enforceability and/or non-infringement of any of the
+  PATENT CLAIMS or otherwise opposing any of the PATENT CLAIMS.
+
+  Tokutek hereby grants to you, for the term and geographical scope of
+  the PATENT CLAIMS, a non-exclusive, no-charge, royalty-free,
+  irrevocable (except as stated in this section) patent license to
+  make, have made, use, offer to sell, sell, import, transfer, and
+  otherwise run, modify, and propagate the contents of THIS
+  IMPLEMENTATION, where such license applies only to the PATENT
+  CLAIMS.  This grant does not include claims that would be infringed
+  only as a consequence of further modifications of THIS
+  IMPLEMENTATION.  If you or your agent or licensee institute or order
+  or agree to the institution of patent litigation against any entity
+  (including a cross-claim or counterclaim in a lawsuit) alleging that
+  THIS IMPLEMENTATION constitutes direct or contributory patent
+  infringement, or inducement of patent infringement, then any rights
+  granted to you under this License shall terminate as of the date
+  such litigation is filed.  If you or your agent or exclusive
+  licensee institute or order or agree to the institution of a PATENT
+  CHALLENGE, then Tokutek may terminate any rights granted to you
+  under this License.
+*/
+
+#ident "Copyright (c) 2007-2013 Tokutek Inc.  All rights reserved."
+#ident "The technology is licensed by the Massachusetts Institute of Technology, Rutgers State University of New Jersey, and the Research Foundation of State University of New York at Stony Brook under United States of America Serial No. 11/760379 and to the patents and/or patent applications resulting from it."
+
+#include <string.h>
+#include <memory.h>
+
+#include <util/memarena.h>
+
+struct memarena {
+    char *buf;
+    size_t buf_used, buf_size;
+    size_t size_of_other_bufs; // the buf_size of all the other bufs.
+    size_t footprint_of_other_bufs; // the footprint of all the other bufs.
+    char **other_bufs;
+    int n_other_bufs;
+};
+
+MEMARENA toku_memarena_create_presized (size_t initial_size) {
+    MEMARENA XMALLOC(result);
+    result->buf_size = initial_size;
+    result->buf_used = 0;
+    result->other_bufs = NULL;
+    result->size_of_other_bufs = 0;
+    result->footprint_of_other_bufs = 0;
+    result->n_other_bufs = 0;
+    XMALLOC_N(result->buf_size, result->buf);
+    return result;
+}
+
+MEMARENA toku_memarena_create (void) {
+    return toku_memarena_create_presized(1024);
+}
+
+void toku_memarena_clear (MEMARENA ma) {
+    // Free the other bufs.
+    int i;
+    for (i=0; i<ma->n_other_bufs; i++) {
+        toku_free(ma->other_bufs[i]);
+        ma->other_bufs[i]=0;
+    }
+    ma->n_other_bufs=0;
+    // But reuse the main buffer
+    ma->buf_used = 0;
+    ma->size_of_other_bufs = 0;
+    ma->footprint_of_other_bufs = 0;
+}
+
+static size_t
+round_to_page (size_t size) {
+    const size_t _PAGE_SIZE = 4096;
+    const size_t result = _PAGE_SIZE+((size-1)&~(_PAGE_SIZE-1));
+    assert(0==(result&(_PAGE_SIZE-1))); // make sure it's aligned
+    assert(result>=size);              // make sure it's not too small
+    assert(result<size+_PAGE_SIZE);     // make sure we didn't grow by more than a page.
+    return result;
+}
+
+void* toku_memarena_malloc (MEMARENA ma, size_t size) {
+    if (ma->buf_size < ma->buf_used + size) {
+        // The existing block isn't big enough.
+        // Add the block to the vector of blocks.
+        if (ma->buf) {
+            int old_n = ma->n_other_bufs;
+            REALLOC_N(old_n+1, ma->other_bufs);
+            assert(ma->other_bufs);
+            ma->other_bufs[old_n]=ma->buf;
+            ma->n_other_bufs = old_n+1;
+            ma->size_of_other_bufs += ma->buf_size;
+            ma->footprint_of_other_bufs += toku_memory_footprint(ma->buf, ma->buf_used);
+        }
+        // Make a new one
+        {
+            size_t new_size = 2*ma->buf_size;
+            if (new_size<size) new_size=size;
+            new_size=round_to_page(new_size); // at least size, but round to the next page size
+            XMALLOC_N(new_size, ma->buf);
+            ma->buf_used = 0;
+            ma->buf_size = new_size;
+        }
+    }
+    // allocate in the existing block.
+    char *result=ma->buf+ma->buf_used;
+    ma->buf_used+=size;
+    return result;
+}
+
+void *toku_memarena_memdup (MEMARENA ma, const void *v, size_t len) {
+    void *r=toku_memarena_malloc(ma, len);
+    memcpy(r,v,len);
+    return r;
+}
+
+void toku_memarena_destroy(MEMARENA *map) {
+    MEMARENA ma=*map;
+    if (ma->buf) {
+        toku_free(ma->buf);
+        ma->buf=0;
+    }
+    int i;
+    for (i=0; i<ma->n_other_bufs; i++) {
+        toku_free(ma->other_bufs[i]);
+    }
+    if (ma->other_bufs) toku_free(ma->other_bufs);
+    ma->other_bufs=0;
+    ma->n_other_bufs=0;
+    toku_free(ma);
+    *map = 0;
+}
+
+#if TOKU_WINDOWS_32
+#include <windows.h>
+#include <crtdbg.h>
+#endif
+
+void toku_memarena_move_buffers(MEMARENA dest, MEMARENA source) {
+    int i;
+    char **other_bufs = dest->other_bufs;
+    static int move_counter = 0;
+    move_counter++;
+    REALLOC_N(dest->n_other_bufs + source->n_other_bufs + 1, other_bufs);
+#if TOKU_WINDOWS_32
+    if (other_bufs == 0) {
+        char **new_other_bufs;
+        printf("_CrtCheckMemory:%d\n", _CrtCheckMemory());
+        printf("Z: move_counter:%d dest:%p %p %d source:%p %p %d errno:%d\n",
+               move_counter,
+               dest, dest->other_bufs, dest->n_other_bufs,
+               source, source->other_bufs, source->n_other_bufs,
+               errno);
+        new_other_bufs = toku_malloc((dest->n_other_bufs + source->n_other_bufs + 1)*sizeof (char **));
+         printf("new_other_bufs=%p errno=%d\n", new_other_bufs, errno);
+    }
+#endif
+
+    dest  ->size_of_other_bufs += source->size_of_other_bufs + source->buf_size;
+    dest  ->footprint_of_other_bufs += source->footprint_of_other_bufs + toku_memory_footprint(source->buf, source->buf_used);
+    source->size_of_other_bufs = 0;
+    source->footprint_of_other_bufs = 0;
+
+    assert(other_bufs);
+    dest->other_bufs = other_bufs;
+    for (i=0; i<source->n_other_bufs; i++) {
+        dest->other_bufs[dest->n_other_bufs++] = source->other_bufs[i];
+    }
+    dest->other_bufs[dest->n_other_bufs++] = source->buf;
+    source->n_other_bufs = 0;
+    toku_free(source->other_bufs);
+    source->other_bufs = 0;
+    source->buf = 0;
+    source->buf_size = 0;
+    source->buf_used = 0;
+
+}
+
+size_t
+toku_memarena_total_memory_size (MEMARENA m)
+{
+    return (toku_memarena_total_size_in_use(m) +
+            sizeof(*m) +
+            m->n_other_bufs * sizeof(*m->other_bufs));
+}
+
+size_t
+toku_memarena_total_size_in_use (MEMARENA m)
+{
+    return m->size_of_other_bufs + m->buf_used;
+}
+
+size_t
+toku_memarena_total_footprint (MEMARENA m)
+{
+    return m->footprint_of_other_bufs + toku_memory_footprint(m->buf, m->buf_used) +
+            sizeof(*m) +
+            m->n_other_bufs * sizeof(*m->other_bufs);
+}
diff --git a/util/memarena.h b/util/memarena.h
new file mode 100644
index 00000000000..0dac262ba46
--- /dev/null
+++ b/util/memarena.h
@@ -0,0 +1,136 @@
+/* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil -*- */
+// vim: ft=cpp:expandtab:ts=8:sw=4:softtabstop=4:
+#ifndef TOKU_MEMARENA_H
+#define TOKU_MEMARENA_H
+
+#ident "$Id$"
+/*
+COPYING CONDITIONS NOTICE:
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of version 2 of the GNU General Public License as
+  published by the Free Software Foundation, and provided that the
+  following conditions are met:
+
+      * Redistributions of source code must retain this COPYING
+        CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
+        DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
+        PATENT MARKING NOTICE (below), and the PATENT RIGHTS
+        GRANT (below).
+
+      * Redistributions in binary form must reproduce this COPYING
+        CONDITIONS NOTICE, the COPYRIGHT NOTICE (below), the
+        DISCLAIMER (below), the UNIVERSITY PATENT NOTICE (below), the
+        PATENT MARKING NOTICE (below), and the PATENT RIGHTS
+        GRANT (below) in the documentation and/or other materials
+        provided with the distribution.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+  02110-1301, USA.
+
+COPYRIGHT NOTICE:
+
+  TokuDB, Tokutek Fractal Tree Indexing Library.
+  Copyright (C) 2007-2013 Tokutek, Inc.
+
+DISCLAIMER:
+
+  This program is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  General Public License for more details.
+
+UNIVERSITY PATENT NOTICE:
+
+  The technology is licensed by the Massachusetts Institute of
+  Technology, Rutgers State University of New Jersey, and the Research
+  Foundation of State University of New York at Stony Brook under
+  United States of America Serial No. 11/760379 and to the patents
+  and/or patent applications resulting from it.
+
+PATENT MARKING NOTICE:
+
+  This software is covered by US Patent No. 8,185,551.
+  This software is covered by US Patent No. 8,489,638.
+
+PATENT RIGHTS GRANT:
+
+  "THIS IMPLEMENTATION" means the copyrightable works distributed by
+  Tokutek as part of the Fractal Tree project.
+
+  "PATENT CLAIMS" means the claims of patents that are owned or
+  licensable by Tokutek, both currently or in the future; and that in
+  the absence of this license would be infringed by THIS
+  IMPLEMENTATION or by using or running THIS IMPLEMENTATION.
+
+  "PATENT CHALLENGE" shall mean a challenge to the validity,
+  patentability, enforceability and/or non-infringement of any of the
+  PATENT CLAIMS or otherwise opposing any of the PATENT CLAIMS.
+
+  Tokutek hereby grants to you, for the term and geographical scope of
+  the PATENT CLAIMS, a non-exclusive, no-charge, royalty-free,
+  irrevocable (except as stated in this section) patent license to
+  make, have made, use, offer to sell, sell, import, transfer, and
+  otherwise run, modify, and propagate the contents of THIS
+  IMPLEMENTATION, where such license applies only to the PATENT
+  CLAIMS.  This grant does not include claims that would be infringed
+  only as a consequence of further modifications of THIS
+  IMPLEMENTATION.  If you or your agent or licensee institute or order
+  or agree to the institution of patent litigation against any entity
+  (including a cross-claim or counterclaim in a lawsuit) alleging that
+  THIS IMPLEMENTATION constitutes direct or contributory patent
+  infringement, or inducement of patent infringement, then any rights
+  granted to you under this License shall terminate as of the date
+  such litigation is filed.  If you or your agent or exclusive
+  licensee institute or order or agree to the institution of a PATENT
+  CHALLENGE, then Tokutek may terminate any rights granted to you
+  under this License.
+*/
+
+#ident "Copyright (c) 2007-2013 Tokutek Inc.  All rights reserved."
+#ident "The technology is licensed by the Massachusetts Institute of Technology, Rutgers State University of New Jersey, and the Research Foundation of State University of New York at Stony Brook under United States of America Serial No. 11/760379 and to the patents and/or patent applications resulting from it."
+
+/* We have too many memory management tricks:
+ *  memarena (this code) is for a collection of objects that cannot be moved.
+ *    The pattern is allocate more and more stuff.
+ *    Don't free items as you go.
+ *    Free all the items at once.
+ *    Then reuse the same buffer again.
+ *    Allocated objects never move.
+ *  A memarena (as currently implemented) is not suitable for interprocess memory sharing.  No reason it couldn't be made to work though.
+ */
+
+struct memarena;
+
+typedef struct memarena *MEMARENA;
+
+MEMARENA toku_memarena_create_presized (size_t initial_size);
+// Effect: Create a memarena with initial size.  In case of ENOMEM, aborts.
+
+MEMARENA toku_memarena_create (void);
+// Effect: Create a memarena with default initial size.  In case of ENOMEM, aborts.
+
+void toku_memarena_clear (MEMARENA ma);
+// Effect: Reset the internal state so that the allocated memory can be used again.
+
+void* toku_memarena_malloc (MEMARENA ma, size_t size);
+// Effect: Allocate some memory.  The returned value remains valid until the memarena is cleared or closed.
+//  In case of ENOMEM, aborts.
+
+void *toku_memarena_memdup (MEMARENA ma, const void *v, size_t len);
+
+void toku_memarena_destroy(MEMARENA *ma);
+
+void toku_memarena_move_buffers(MEMARENA dest, MEMARENA source);
+// Effect: Move all the memory from SOURCE into DEST.  When SOURCE is closed the memory won't be freed.  When DEST is closed, the memory will be freed.  (Unless DEST moves its memory to another memarena...)
+
+size_t toku_memarena_total_memory_size (MEMARENA);
+// Effect: Calculate the amount of memory used by a memory arena.
+
+size_t toku_memarena_total_size_in_use (MEMARENA);
+
+size_t toku_memarena_total_footprint (MEMARENA);
+
+#endif