e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
124 lines
3.6 KiB
C
124 lines
3.6 KiB
C
/* SPDX-FileCopyrightText: 2008 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*/
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct BLI_mempool;
|
|
struct BLI_mempool_chunk;
|
|
|
|
typedef struct BLI_mempool BLI_mempool;
|
|
|
|
BLI_mempool *BLI_mempool_create(unsigned int esize,
|
|
unsigned int elem_num,
|
|
unsigned int pchunk,
|
|
unsigned int flag)
|
|
ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL;
|
|
void *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL
|
|
ATTR_NONNULL(1);
|
|
void *BLI_mempool_calloc(BLI_mempool *pool)
|
|
ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_RETURNS_NONNULL ATTR_NONNULL(1);
|
|
/**
|
|
* Free an element from the mempool.
|
|
*
|
|
* \note doesn't protect against double frees, take care!
|
|
*/
|
|
void BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
|
|
/**
|
|
* Empty the pool, as if it were just created.
|
|
*
|
|
* \param pool: The pool to clear.
|
|
* \param totelem_reserve: Optionally reserve how many items should be kept from clearing.
|
|
*/
|
|
void BLI_mempool_clear_ex(BLI_mempool *pool, int totelem_reserve) ATTR_NONNULL(1);
|
|
/**
|
|
* Wrap #BLI_mempool_clear_ex with no reserve set.
|
|
*/
|
|
void BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
|
|
/**
|
|
* Free the mempool itself (and all elements).
|
|
*/
|
|
void BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
|
|
int BLI_mempool_len(const BLI_mempool *pool) ATTR_NONNULL(1);
|
|
void *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT
|
|
ATTR_NONNULL(1);
|
|
|
|
/**
|
|
* Fill in \a data with pointers to each element of the mempool,
|
|
* to create lookup table.
|
|
*
|
|
* \param pool: Pool to create a table from.
|
|
* \param data: array of pointers at least the size of 'pool->totused'
|
|
*/
|
|
void BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
|
|
/**
|
|
* A version of #BLI_mempool_as_table that allocates and returns the data.
|
|
*/
|
|
void **BLI_mempool_as_tableN(BLI_mempool *pool,
|
|
const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
|
|
ATTR_NONNULL(1, 2);
|
|
/**
|
|
* Fill in \a data with the contents of the mempool.
|
|
*/
|
|
void BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
|
|
/**
|
|
* A version of #BLI_mempool_as_array that allocates and returns the data.
|
|
*/
|
|
void *BLI_mempool_as_arrayN(BLI_mempool *pool,
|
|
const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
|
|
ATTR_NONNULL(1, 2);
|
|
|
|
#ifndef NDEBUG
|
|
void BLI_mempool_set_memory_debug(void);
|
|
#endif
|
|
|
|
/**
|
|
* Iteration stuff.
|
|
* \note this may easy to produce bugs with.
|
|
*/
|
|
|
|
/** \note Private structure. */
|
|
typedef struct BLI_mempool_iter {
|
|
BLI_mempool *pool;
|
|
struct BLI_mempool_chunk *curchunk;
|
|
unsigned int curindex;
|
|
} BLI_mempool_iter;
|
|
|
|
/** #BLI_mempool.flag */
|
|
enum {
|
|
BLI_MEMPOOL_NOP = 0,
|
|
/**
|
|
* Allow iterating on this mempool.
|
|
*
|
|
* \note this requires that the first four bytes of the elements
|
|
* never begin with 'free' (#FREEWORD).
|
|
* \note order of iteration is only assured to be the
|
|
* order of allocation when no chunks have been freed.
|
|
*/
|
|
BLI_MEMPOOL_ALLOW_ITER = (1 << 0),
|
|
};
|
|
|
|
/**
|
|
* Initialize a new mempool iterator, #BLI_MEMPOOL_ALLOW_ITER flag must be set.
|
|
*/
|
|
void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter) ATTR_NONNULL();
|
|
/**
|
|
* Step over the iterator, returning the mempool item or NULL.
|
|
*/
|
|
void *BLI_mempool_iterstep(BLI_mempool_iter *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|