Sat, 28 Oct 2017 15:43:51 +0200
modules documentation
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
1 | /* |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
2 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
3 | * |
259 | 4 | * Copyright 2017 Mike Becker, Olaf Wintermann All rights reserved. |
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
5 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
6 | * Redistribution and use in source and binary forms, with or without |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
7 | * modification, are permitted provided that the following conditions are met: |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
8 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
9 | * 1. Redistributions of source code must retain the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
10 | * notice, this list of conditions and the following disclaimer. |
13 | 11 | * |
103
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
12 | * 2. Redistributions in binary form must reproduce the above copyright |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
13 | * notice, this list of conditions and the following disclaimer in the |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
14 | * documentation and/or other materials provided with the distribution. |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
15 | * |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
16 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
17 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
18 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
19 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
20 | * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
21 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
22 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
23 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
24 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
25 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
08018864fb91
added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents:
69
diff
changeset
|
26 | * POSSIBILITY OF SUCH DAMAGE. |
13 | 27 | */ |
28 | ||
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
29 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
30 | * @file mempool.h |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
31 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
32 | * Memory pool implementation. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
33 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
34 | * @author Mike Becker |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
35 | * @author Olaf Wintermann |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
36 | */ |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
37 | |
120 | 38 | #ifndef UCX_MEMPOOL_H |
39 | #define UCX_MEMPOOL_H | |
13 | 40 | |
259 | 41 | #include "ucx.h" |
42 | #include "allocator.h" | |
38
35f67a8ef875
added missing stddef includes
Mike Becker <universe@uap-core.de>
parents:
16
diff
changeset
|
43 | #include <stddef.h> |
35f67a8ef875
added missing stddef includes
Mike Becker <universe@uap-core.de>
parents:
16
diff
changeset
|
44 | |
13 | 45 | #ifdef __cplusplus |
46 | extern "C" { | |
47 | #endif | |
48 | ||
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
49 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
50 | * UCX mempool structure. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
51 | */ |
13 | 52 | typedef struct { |
158
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
53 | /** UcxAllocator based on this pool */ |
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
54 | UcxAllocator *allocator; |
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
55 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
56 | /** List of pointers to pooled memory. */ |
158
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
57 | void **data; |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
141
diff
changeset
|
58 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
59 | /** Count of pooled memory items. */ |
158
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
60 | size_t ndata; |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
141
diff
changeset
|
61 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
62 | /** Memory pool size. */ |
158
81d580042da1
Added allocator to mempool struct + fixed suncc.mk
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
146
diff
changeset
|
63 | size_t size; |
13 | 64 | } UcxMempool; |
65 | ||
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
66 | /** Shorthand for a new default memory pool with a capacity of 16 elements. */ |
13 | 67 | #define ucx_mempool_new_default() ucx_mempool_new(16) |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
68 | |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
69 | |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
70 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
71 | * Creates a memory pool with the specified initial size. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
72 | * |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
73 | * As the created memory pool automatically grows in size by factor two when |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
74 | * trying to allocate memory on a full pool, it is recommended that you use |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
75 | * a power of two for the initial size. |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
76 | * |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
77 | * @param n initial pool size (should be a power of two, e.g. 16) |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
78 | * @return a pointer to the new memory pool |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
79 | * @see ucx_mempool_new_default() |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
80 | */ |
13 | 81 | UcxMempool *ucx_mempool_new(size_t n); |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
82 | |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
83 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
84 | * Resizes a memory pool. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
85 | * |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
86 | * This function will fail if the new capacity is not sufficient for the |
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
87 | * present data. |
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
88 | * |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
89 | * @param pool the pool to resize |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
90 | * @param newcap the new capacity |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
91 | * @return zero on success or non-zero on failure |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
92 | */ |
15
2dc4c688c262
fixed mpool compiler warnings
Mike Becker <universe@uap-core.de>
parents:
13
diff
changeset
|
93 | int ucx_mempool_chcap(UcxMempool *pool, size_t newcap); |
13 | 94 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
95 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
96 | * Allocates pooled memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
97 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
98 | * @param pool the memory pool |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
99 | * @param n amount of memory to allocate |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
100 | * @return a pointer to the allocated memory |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
101 | * @see ucx_allocator_malloc() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
102 | */ |
13 | 103 | void *ucx_mempool_malloc(UcxMempool *pool, size_t n); |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
104 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
105 | * Allocates a pooled memory array. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
106 | * |
181
1e9012ad8215
fixed stream copy bug + fixed doc issues in mempool
Mike Becker <universe@uap-core.de>
parents:
177
diff
changeset
|
107 | * The content of the allocated memory is set to zero. |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
108 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
109 | * @param pool the memory pool |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
110 | * @param nelem amount of elements to allocate |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
111 | * @param elsize amount of memory per element |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
112 | * @return a pointer to the allocated memory |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
113 | * @see ucx_allocator_calloc() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
114 | */ |
13 | 115 | void *ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
141
diff
changeset
|
116 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
117 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
118 | * Reallocates pooled memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
119 | * |
215
e0853e077770
removed some implementation details from documentation + fixed ucx_buffer_write doc
Mike Becker <universe@uap-core.de>
parents:
209
diff
changeset
|
120 | * If the memory to be reallocated is not contained by the specified pool, the |
e0853e077770
removed some implementation details from documentation + fixed ucx_buffer_write doc
Mike Becker <universe@uap-core.de>
parents:
209
diff
changeset
|
121 | * behavior is undefined. |
141
c466e2a6cbd0
added mempool clamp + some minor fixes
Mike Becker <universe@uap-core.de>
parents:
135
diff
changeset
|
122 | * |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
123 | * @param pool the memory pool |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
124 | * @param ptr a pointer to the memory that shall be reallocated |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
125 | * @param n the new size of the memory |
181
1e9012ad8215
fixed stream copy bug + fixed doc issues in mempool
Mike Becker <universe@uap-core.de>
parents:
177
diff
changeset
|
126 | * @return a pointer to the new location of the memory |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
127 | * @see ucx_allocator_realloc() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
128 | */ |
13 | 129 | void *ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n); |
146
aa376dba1ba8
fixed documentation for netbeans parser + added sstrprefix() and sstrsuffix()
Mike Becker <universe@uap-core.de>
parents:
141
diff
changeset
|
130 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
131 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
132 | * Frees pooled memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
133 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
134 | * Before freeing the memory, the specified destructor function (if any) |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
135 | * is called. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
136 | * |
215
e0853e077770
removed some implementation details from documentation + fixed ucx_buffer_write doc
Mike Becker <universe@uap-core.de>
parents:
209
diff
changeset
|
137 | * If you specify memory, that is not pooled by the specified memory pool, the |
241
661f33ef20d8
removes unused ucx_mempool_clamp() and changes storage behavior of mempool to increase the capacity by a factor of two
Mike Becker <universe@uap-core.de>
parents:
225
diff
changeset
|
138 | * program will terminate with a call to <code>abort()</code>. |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
139 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
140 | * @param pool the memory pool |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
141 | * @param ptr a pointer to the memory that shall be freed |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
142 | * @see ucx_mempool_set_destr() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
143 | */ |
113
8693d7874773
added mempool allocator
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
103
diff
changeset
|
144 | void ucx_mempool_free(UcxMempool *pool, void *ptr); |
13 | 145 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
146 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
147 | * Destroys a memory pool. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
148 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
149 | * For each element the destructor function (if any) is called and the element |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
150 | * is freed. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
151 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
152 | * Each of the registered destructor function that has no corresponding element |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
153 | * within the pool (namely those registered by ucx_mempool_reg_destr) is |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
154 | * called interleaving with the element destruction, but with guarantee to the |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
155 | * order in which they were registered (FIFO order). |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
156 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
157 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
158 | * @param pool the mempool to destroy |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
159 | */ |
113
8693d7874773
added mempool allocator
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
103
diff
changeset
|
160 | void ucx_mempool_destroy(UcxMempool *pool); |
13 | 161 | |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
162 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
163 | * Sets a destructor function for the specified memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
164 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
165 | * The destructor is automatically called when the memory is freed or the |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
166 | * pool is destroyed. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
167 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
168 | * The only requirement for the specified memory is, that it <b>MUST</b> be |
225
a1a068c2c4ef
updates documenting comments
Mike Becker <universe@uap-core.de>
parents:
215
diff
changeset
|
169 | * pooled memory by a UcxMempool or an element-compatible mempool. The pointer |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
170 | * to the destructor function is saved in a reserved area before the actual |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
171 | * memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
172 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
173 | * @param ptr pooled memory |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
174 | * @param func a pointer to the destructor function |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
175 | * @see ucx_mempool_free() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
176 | * @see ucx_mempool_destroy() |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
177 | */ |
13 | 178 | void ucx_mempool_set_destr(void *ptr, ucx_destructor func); |
135
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
179 | |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
180 | /** |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
181 | * Registers a destructor function for the specified (non-pooled) memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
182 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
183 | * This is useful, if you have memory that has not been allocated by a mempool, |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
184 | * but shall be managed by a mempool. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
185 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
186 | * This function creates an entry in the specified mempool and the memory will |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
187 | * therefore (logically) convert to pooled memory. |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
188 | * |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
189 | * @param pool the memory pool |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
190 | * @param ptr data the destructor is registered for |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
191 | * @param destr a pointer to the destructor function |
a0aa1c15f46b
documented mempool + some fixes
Mike Becker <universe@uap-core.de>
parents:
120
diff
changeset
|
192 | */ |
13 | 193 | void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr); |
194 | ||
195 | #ifdef __cplusplus | |
196 | } | |
197 | #endif | |
198 | ||
120 | 199 | #endif /* UCX_MEMPOOL_H */ |
13 | 200 |