CMake: add WITH_LINKER_LLD option for unix platforms
[blender-staging.git] / source / blender / blenlib / BLI_mempool.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_MEMPOOL_H__
21 #define __BLI_MEMPOOL_H__
22
23 /** \file
24  * \ingroup bli
25  */
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #include "BLI_compiler_attrs.h"
32 #include "BLI_utildefines.h"
33
34 struct BLI_mempool;
35 struct BLI_mempool_chunk;
36
37 typedef struct BLI_mempool BLI_mempool;
38
39 BLI_mempool *BLI_mempool_create(unsigned int esize,
40                                 unsigned int totelem,
41                                 unsigned int pchunk,
42                                 unsigned int flag) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT;
43 void *BLI_mempool_alloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
44 void *BLI_mempool_calloc(BLI_mempool *pool) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
45 void BLI_mempool_free(BLI_mempool *pool, void *addr) ATTR_NONNULL(1, 2);
46 void BLI_mempool_clear_ex(BLI_mempool *pool, const int totelem_reserve) ATTR_NONNULL(1);
47 void BLI_mempool_clear(BLI_mempool *pool) ATTR_NONNULL(1);
48 void BLI_mempool_destroy(BLI_mempool *pool) ATTR_NONNULL(1);
49 int BLI_mempool_len(BLI_mempool *pool) ATTR_NONNULL(1);
50 void *BLI_mempool_findelem(BLI_mempool *pool, unsigned int index) ATTR_WARN_UNUSED_RESULT
51     ATTR_NONNULL(1);
52
53 void BLI_mempool_as_table(BLI_mempool *pool, void **data) ATTR_NONNULL(1, 2);
54 void **BLI_mempool_as_tableN(BLI_mempool *pool,
55                              const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
56     ATTR_NONNULL(1, 2);
57 void BLI_mempool_as_array(BLI_mempool *pool, void *data) ATTR_NONNULL(1, 2);
58 void *BLI_mempool_as_arrayN(BLI_mempool *pool,
59                             const char *allocstr) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
60     ATTR_NONNULL(1, 2);
61
62 #ifndef NDEBUG
63 void BLI_mempool_set_memory_debug(void);
64 #endif
65
66 /** iteration stuff.  note: this may easy to produce bugs with */
67 /* private structure */
68 typedef struct BLI_mempool_iter {
69   BLI_mempool *pool;
70   struct BLI_mempool_chunk *curchunk;
71   unsigned int curindex;
72
73   struct BLI_mempool_chunk **curchunk_threaded_shared;
74 } BLI_mempool_iter;
75
76 /* flag */
77 enum {
78   BLI_MEMPOOL_NOP = 0,
79   /** allow iterating on this mempool.
80    *
81    * \note this requires that the first four bytes of the elements
82    * never begin with 'free' (#FREEWORD).
83    * \note order of iteration is only assured to be the
84    * order of allocation when no chunks have been freed.
85    */
86   BLI_MEMPOOL_ALLOW_ITER = (1 << 0),
87 };
88
89 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter) ATTR_NONNULL();
90 void *BLI_mempool_iterstep(BLI_mempool_iter *iter) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
91
92 BLI_mempool_iter *BLI_mempool_iter_threadsafe_create(BLI_mempool *pool,
93                                                      const size_t num_iter) ATTR_WARN_UNUSED_RESULT
94     ATTR_NONNULL();
95 void BLI_mempool_iter_threadsafe_free(BLI_mempool_iter *iter_arr) ATTR_NONNULL();
96
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif /* __BLI_MEMPOOL_H__ */