aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/core/lib/gpr/arena.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/lib/gpr/arena.h')
-rw-r--r--src/core/lib/gpr/arena.h39
1 files changed, 39 insertions, 0 deletions
diff --git a/src/core/lib/gpr/arena.h b/src/core/lib/gpr/arena.h
new file mode 100644
index 0000000000..339771c0e3
--- /dev/null
+++ b/src/core/lib/gpr/arena.h
@@ -0,0 +1,39 @@
+/*
+ *
+ * Copyright 2017 gRPC authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// \file Arena based allocator
+// Allows very fast allocation of memory, but that memory cannot be freed until
+// the arena as a whole is freed
+// Tracks the total memory allocated against it, so that future arenas can
+// pre-allocate the right amount of memory
+
+#ifndef GRPC_CORE_LIB_GPR_ARENA_H
+#define GRPC_CORE_LIB_GPR_ARENA_H
+
+#include <stddef.h>
+
+typedef struct gpr_arena gpr_arena;
+
+// Create an arena, with \a initial_size bytes in the first allocated buffer
+gpr_arena* gpr_arena_create(size_t initial_size);
+// Allocate \a size bytes from the arena
+void* gpr_arena_alloc(gpr_arena* arena, size_t size);
+// Destroy an arena, returning the total number of bytes allocated
+size_t gpr_arena_destroy(gpr_arena* arena);
+
+#endif /* GRPC_CORE_LIB_GPR_ARENA_H */