source/blender/blenlib/BLI_memarena.h

   1 /* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
   2  *
   3  * SPDX-License-Identifier: GPL-2.0-or-later */
   4
   5 /** \file
   6  * \ingroup bli
   7  */
   8
   9 #pragma once
  10
  11 #include <stddef.h>
  12
  13 #include "BLI_compiler_attrs.h"
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /**
  20  * A reasonable standard buffer size, big enough to not cause much internal fragmentation,
  21  * small enough not to waste resources
  22  */
  23 #define BLI_MEMARENA_STD_BUFSIZE MEM_SIZE_OPTIMAL(1 << 14)
  24
  25 struct MemArena;
  26 typedef struct MemArena MemArena;
  27
  28 struct MemArena *BLI_memarena_new(size_t bufsize,
  29                                   const char *name) ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL
  30     ATTR_NONNULL(2) ATTR_MALLOC;
  31 void BLI_memarena_free(struct MemArena *ma) ATTR_NONNULL(1);
  32 void BLI_memarena_use_malloc(struct MemArena *ma) ATTR_NONNULL(1);
  33 void BLI_memarena_use_calloc(struct MemArena *ma) ATTR_NONNULL(1);
  34 void BLI_memarena_use_align(struct MemArena *ma, size_t align) ATTR_NONNULL(1);
  35 void *BLI_memarena_alloc(struct MemArena *ma, size_t size) ATTR_WARN_UNUSED_RESULT
  36     ATTR_NONNULL(1) ATTR_MALLOC ATTR_ALLOC_SIZE(2);
  37 void *BLI_memarena_calloc(struct MemArena *ma, size_t size) ATTR_WARN_UNUSED_RESULT
  38     ATTR_NONNULL(1) ATTR_MALLOC ATTR_ALLOC_SIZE(2);
  39
  40 /**
  41  * Transfer ownership of allocated blocks from `ma_src` into `ma_dst`,
  42  * cleaning the contents of `ma_src`.
  43  *
  44  * \note Useful for multi-threaded tasks that need a thread-local #MemArena
  45  * that is kept after the multi-threaded operation is completed.
  46  *
  47  * \note Avoid accumulating memory pools where possible
  48  * as any unused memory in `ma_src` is wasted every merge.
  49  */
  50 void BLI_memarena_merge(MemArena *ma_dst, MemArena *ma_src) ATTR_NONNULL(1, 2);
  51
  52 /**
  53  * Clear for reuse, avoids re-allocation when an arena may
  54  * otherwise be freed and recreated.
  55  */
  56 void BLI_memarena_clear(MemArena *ma) ATTR_NONNULL(1);
  57
  58 #ifdef __cplusplus
  59 }
  60 #endif