From a38b35cdb839dd6c1e4190b42d0c6b830aeed759 Mon Sep 17 00:00:00 2001
From: Kia <ito@fastmail.jp>
Date: Tue, 1 Dec 2020 18:57:14 -0700
Subject: [PATCH] start work on jemalloc interface
---
src/je_allocator.c | 269 +++++++++++++++++++++++++++++++++++++++++++++
src/je_allocator.h | 93 ++++++++++++++++
2 files changed, 362 insertions(+)
create mode 100644 src/je_allocator.c
create mode 100644 src/je_allocator.h
diff --git a/src/je_allocator.c b/src/je_allocator.c
new file mode 100644
index 00000000..2ff5caca
--- /dev/null
+++ b/src/je_allocator.c
@@ -0,0 +1,269 @@
+/* Arena allocator for Hammer.
+ * Copyright (C) 2012 Meredith L. Patterson, Dan "TQ" Hirsch
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, version 2.
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+#include <string.h>
+#include <stdint.h>
+#include <sys/types.h>
+#include <setjmp.h>
+
+#include "hammer.h"
+#include "internal.h"
+
+
+struct arena_link {
+ // TODO:
+ // For efficiency, we should probably allocate the arena links in
+ // their own slice, and link to a block directly. That can be
+ // implemented later, though, with no change in interface.
+ struct arena_link *next;
+ size_t free;
+ size_t used;
+ uint8_t rest[];
+};
+
+struct HArena_ {
+ struct arena_link *head;
+ struct HAllocator_ *mm__;
+ /* does mm__ zero blocks for us? */
+ bool malloc_zeros;
+ size_t block_size;
+ size_t used;
+ size_t wasted;
+#ifdef DETAILED_ARENA_STATS
+ size_t mm_malloc_count, mm_malloc_bytes;
+ size_t memset_count, memset_bytes;
+ size_t arena_malloc_count, arena_malloc_bytes;
+ size_t arena_su_malloc_count, arena_su_malloc_bytes;
+ size_t arena_si_malloc_count, arena_si_malloc_bytes;
+ size_t arena_lu_malloc_count, arena_lu_malloc_bytes;
+ size_t arena_li_malloc_count, arena_li_malloc_bytes;
+#endif
+
+ jmp_buf *except;
+};
+
+static void * h_arena_malloc_raw(HArena *arena, size_t size, bool need_zero);
+
+void* h_alloc(HAllocator* mm__, size_t size) {
+ void *p = mm__->alloc(mm__, size);
+ if(!p)
+ h_platform_errx(1, "memory allocation failed (%uB requested)\n", (unsigned int)size);
+ return p;
+}
+
+HArena *h_new_arena(HAllocator* mm__, size_t block_size) {
+ if (block_size == 0)
+ block_size = 4096;
+ struct HArena_ *ret = h_new(struct HArena_, 1);
+ struct arena_link *link = (struct arena_link*)h_alloc(mm__, sizeof(struct arena_link) + block_size);
+ assert(ret != NULL);
+ assert(link != NULL);
+ link->free = block_size;
+ link->used = 0;
+ link->next = NULL;
+ ret->head = link;
+ ret->block_size = block_size;
+ ret->used = 0;
+ ret->mm__ = mm__;
+#ifdef DETAILED_ARENA_STATS
+ ret->mm_malloc_count = 2;
+ ret->mm_malloc_bytes = sizeof(*ret) + sizeof(struct arena_link) + block_size;
+ ret->memset_count = 0;
+ ret->memset_bytes = 0;
+ ret->arena_malloc_count = ret->arena_malloc_bytes = 0;
+ ret->arena_su_malloc_count = ret->arena_su_malloc_bytes = 0;
+ ret->arena_si_malloc_count = ret->arena_si_malloc_bytes = 0;
+ ret->arena_lu_malloc_count = ret->arena_lu_malloc_bytes = 0;
+ ret->arena_li_malloc_count = ret->arena_li_malloc_bytes = 0;
+#endif
+ /* XXX provide a mechanism to indicate mm__ returns zeroed blocks */
+ ret->malloc_zeros = false;
+ ret->wasted = sizeof(struct arena_link) + sizeof(struct HArena_) + block_size;
+ ret->except = NULL;
+ return ret;
+}
+
+void h_arena_set_except(HArena *arena, jmp_buf *except)
+{
+ arena->except = except;
+}
+
+static void *alloc_block(HArena *arena, size_t size)
+{
+ void *block = arena->mm__->alloc(arena->mm__, size);
+ if (!block) {
+ if (arena->except)
+ longjmp(*arena->except, 1);
+ h_platform_errx(1, "memory allocation failed (%uB requested)\n", (unsigned int)size);
+ }
+ return block;
+}
+
+void * h_arena_malloc_noinit(HArena *arena, size_t size) {
+ return h_arena_malloc_raw(arena, size, false);
+}
+
+void * h_arena_malloc(HArena *arena, size_t size) {
+ return h_arena_malloc_raw(arena, size, true);
+}
+
+static void * h_arena_malloc_raw(HArena *arena, size_t size,
+ bool need_zero) {
+ struct arena_link *link = NULL;
+ void *ret = NULL;
+
+ if (size <= arena->head->free) {
+ /* fast path.. */
+ ret = arena->head->rest + arena->head->used;
+ arena->used += size;
+ arena->wasted -= size;
+ arena->head->used += size;
+ arena->head->free -= size;
+
+#ifdef DETAILED_ARENA_STATS
+ ++(arena->arena_malloc_count);
+ arena->arena_malloc_bytes += size;
+ if (need_zero) {
+ ++(arena->arena_si_malloc_count);
+ arena->arena_si_malloc_bytes += size;
+ } else {
+ ++(arena->arena_su_malloc_count);
+ arena->arena_su_malloc_bytes += size;
+ }
+#endif
+ } else if (size > arena->block_size) {
+ /*
+ * We need a new, dedicated block for it, because it won't fit in a
+ * standard sized one.
+ *
+ * NOTE:
+ *
+ * We used to do a silly casting dance to treat blocks like this
+ * as special cases and make the used/free fields part of the allocated
+ * block, but the old code was not really proper portable C and depended
+ * on a bunch of implementation-specific behavior. We could have done it
+ * better with a union in struct arena_link, but the memory savings is
+ * only 0.39% for a 64-bit machine, a 4096-byte block size and all
+ * large allocations *only just one byte* over the block size, so I
+ * question the utility of it. We do still slip the large block in
+ * one position behind the list head so it doesn't cut off a partially
+ * filled list head.
+ *
+ * -- andrea
+ */
+ link = alloc_block(arena, size + sizeof(struct arena_link));
+ assert(link != NULL);
+ arena->used += size;
+ arena->wasted += sizeof(struct arena_link);
+ link->used = size;
+ link->free = 0;
+ link->next = arena->head->next;
+ arena->head->next = link;
+ ret = link->rest;
+
+#ifdef DETAILED_ARENA_STATS
+ ++(arena->arena_malloc_count);
+ arena->arena_malloc_bytes += size;
+ if (need_zero) {
+ ++(arena->arena_li_malloc_count);
+ arena->arena_li_malloc_bytes += size;
+ } else {
+ ++(arena->arena_lu_malloc_count);
+ arena->arena_lu_malloc_bytes += size;
+ }
+#endif
+ } else {
+ /* we just need to allocate an ordinary new block. */
+ link = alloc_block(arena, sizeof(struct arena_link) + arena->block_size);
+ assert(link != NULL);
+#ifdef DETAILED_ARENA_STATS
+ ++(arena->mm_malloc_count);
+ arena->mm_malloc_bytes += sizeof(struct arena_link) + arena->block_size;
+#endif
+ link->free = arena->block_size - size;
+ link->used = size;
+ link->next = arena->head;
+ arena->head = link;
+ arena->used += size;
+ arena->wasted += sizeof(struct arena_link) + arena->block_size - size;
+ ret = link->rest;
+
+#ifdef DETAILED_ARENA_STATS
+ ++(arena->arena_malloc_count);
+ arena->arena_malloc_bytes += size;
+ if (need_zero) {
+ ++(arena->arena_si_malloc_count);
+ arena->arena_si_malloc_bytes += size;
+ } else {
+ ++(arena->arena_su_malloc_count);
+ arena->arena_su_malloc_bytes += size;
+ }
+#endif
+ }
+
+ /*
+ * Zeroize if necessary
+ */
+ if (need_zero && !(arena->malloc_zeros)) {
+ memset(ret, 0, size);
+#ifdef DETAILED_ARENA_STATS
+ ++(arena->memset_count);
+ arena->memset_bytes += size;
+#endif
+ }
+
+ return ret;
+}
+
+void h_arena_free(HArena *arena, void* ptr) {
+ // To be used later...
+}
+
+void h_delete_arena(HArena *arena) {
+ HAllocator *mm__ = arena->mm__;
+ struct arena_link *link = arena->head;
+ while (link) {
+ struct arena_link *next = link->next;
+ // Even in the case of a special block, without the full arena
+ // header, this is correct, because the next pointer is the first
+ // in the structure.
+ h_free(link);
+ link = next;
+ }
+ h_free(arena);
+}
+
+void h_allocator_stats(HArena *arena, HArenaStats *stats) {
+ stats->used = arena->used;
+ stats->wasted = arena->wasted;
+#ifdef DETAILED_ARENA_STATS
+ stats->mm_malloc_count = arena->mm_malloc_count;
+ stats->mm_malloc_bytes = arena->mm_malloc_bytes;
+ stats->memset_count = arena->memset_count;
+ stats->memset_bytes = arena->memset_bytes;
+ stats->arena_malloc_count = arena->arena_malloc_count;
+ stats->arena_malloc_bytes = arena->arena_malloc_bytes;
+ stats->arena_su_malloc_count = arena->arena_su_malloc_count;
+ stats->arena_su_malloc_bytes = arena->arena_su_malloc_bytes;
+ stats->arena_si_malloc_count = arena->arena_si_malloc_count;
+ stats->arena_si_malloc_bytes = arena->arena_si_malloc_bytes;
+ stats->arena_lu_malloc_count = arena->arena_lu_malloc_count;
+ stats->arena_lu_malloc_bytes = arena->arena_lu_malloc_bytes;
+ stats->arena_li_malloc_count = arena->arena_li_malloc_count;
+ stats->arena_li_malloc_bytes = arena->arena_li_malloc_bytes;
+#endif
+}
diff --git a/src/je_allocator.h b/src/je_allocator.h
new file mode 100644
index 00000000..06d1e6f5
--- /dev/null
+++ b/src/je_allocator.h
@@ -0,0 +1,93 @@
+/* Arena allocator for Hammer.
+ * Copyright (C) 2012 Meredith L. Patterson, Dan "TQ" Hirsch
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, version 2.
+ *
+ * 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.
+ *
+ * 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.
+ */
+
+#ifndef HAMMER_ALLOCATOR__H__
+#define HAMMER_ALLOCATOR__H__
+#include <sys/types.h>
+#include <setjmp.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if defined __llvm__
+# if __has_attribute(malloc)
+# define ATTR_MALLOC(n) __attribute__((malloc))
+# else
+# define ATTR_MALLOC(n)
+# endif
+#elif defined SWIG
+# define ATTR_MALLOC(n)
+#elif defined __GNUC__
+# define ATTR_MALLOC(n) __attribute__((malloc, alloc_size(2)))
+#else
+# define ATTR_MALLOC(n)
+#endif
+
+/* #define DETAILED_ARENA_STATS */
+
+// TODO(thequux): Turn this into an "HAllocatorVtable", and add a wrapper that also takes an environment pointer.
+typedef struct HAllocator_ {
+ void* (*alloc)(struct HAllocator_* allocator, size_t size);
+ void* (*realloc)(struct HAllocator_* allocator, void* ptr, size_t size);
+ void (*free)(struct HAllocator_* allocator, void* ptr);
+} HAllocator;
+
+void* h_alloc(HAllocator* allocator, size_t size) ATTR_MALLOC(2);
+
+typedef struct HArena_ HArena ; // hidden implementation
+
+HArena *h_new_arena(HAllocator* allocator, size_t block_size); // pass 0 for default...
+
+void* h_arena_malloc_noinit(HArena *arena, size_t count) ATTR_MALLOC(2);
+void* h_arena_malloc(HArena *arena, size_t count) ATTR_MALLOC(2);
+void h_arena_free(HArena *arena, void* ptr); // For future expansion, with alternate memory managers.
+void h_delete_arena(HArena *arena);
+void h_arena_set_except(HArena *arena, jmp_buf *except);
+
+typedef struct {
+ size_t used;
+ size_t wasted;
+#ifdef DETAILED_ARENA_STATS
+ size_t mm_malloc_count;
+ size_t mm_malloc_bytes;
+ size_t memset_count;
+ size_t memset_bytes;
+ size_t arena_malloc_count;
+ size_t arena_malloc_bytes;
+ /* small, uninited */
+ size_t arena_su_malloc_count;
+ size_t arena_su_malloc_bytes;
+ /* small, inited */
+ size_t arena_si_malloc_count;
+ size_t arena_si_malloc_bytes;
+ /* large, uninited */
+ size_t arena_lu_malloc_count;
+ size_t arena_lu_malloc_bytes;
+ /* large, inited */
+ size_t arena_li_malloc_count;
+ size_t arena_li_malloc_bytes;
+#endif
+} HArenaStats;
+
+void h_allocator_stats(HArena *arena, HArenaStats *stats);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // #ifndef LIB_ALLOCATOR__H__
--
GitLab