src/cx/mempool.h

Fri, 07 Jul 2023 17:28:07 +0200

author
Mike Becker <universe@uap-core.de>
date
Fri, 07 Jul 2023 17:28:07 +0200
changeset 733
2ed01495f838
parent 727
d92a59f5d261
child 742
bcf788f3f6f5
permissions
-rw-r--r--

add iterator documentation

571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
1 /*
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
3 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
6 * Redistribution and use in source and binary forms, with or without
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
7 * modification, are permitted provided that the following conditions are met:
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
10 * notice, this list of conditions and the following disclaimer.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
11 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14 * documentation and/or other materials provided with the distribution.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
27 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
28 /**
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
29 * \file mempool.h
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30 * \brief Interface for memory pool implementations.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
31 * \author Mike Becker
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
32 * \author Olaf Wintermann
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
33 * \version 3.0
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
34 * \copyright 2-Clause BSD License
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
36
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
37 #ifndef UCX_MEMPOOL_H
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
38 #define UCX_MEMPOOL_H
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
39
681
502105523db7 fix common.h include problems - fixes #255
Mike Becker <universe@uap-core.de>
parents: 571
diff changeset
40 #include "common.h"
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
41 #include "allocator.h"
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
42
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
43 #ifdef __cplusplus
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44 extern "C" {
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
45 #endif
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
46
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
47 /** Internal structure for pooled memory. */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
48 struct cx_mempool_memory_s;
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
49
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
50 /**
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
51 * The basic structure of a memory pool.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
52 * Should be the first member of an actual memory pool implementation.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
53 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
54 struct cx_mempool_s {
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
55 /** The provided allocator. */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
56 CxAllocator const *allocator;
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
57
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
58 /**
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
59 * A destructor that shall be automatically registered for newly allocated memory.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
60 * This destructor MUST NOT free the memory.
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
61 */
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
62 cx_destructor_func auto_destr;
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
63
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
64 /** Array of pooled memory. */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
65 struct cx_mempool_memory_s **data;
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
66
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
67 /** Number of pooled memory items. */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
68 size_t size;
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
69
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
70 /** Memory pool capacity. */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
71 size_t capacity;
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
72 };
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
73
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
74 /**
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
75 * Common type for all memory pool implementations.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
76 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
77 typedef struct cx_mempool_s CxMempool;
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
78
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
79 /**
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
80 * Creates an array-based memory pool with a shared destructor function.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
81 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
82 * This destructor MUST NOT free the memory.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
83 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
84 * @param capacity the initial capacity of the pool
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
85 * @param destr the destructor function to use for allocated memory
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
86 * @return the created memory pool or \c NULL if allocation failed
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
87 */
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
88 __attribute__((__warn_unused_result__))
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
89 CxMempool *cxMempoolCreate(size_t capacity, cx_destructor_func destr);
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
90
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
91 /**
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
92 * Creates a basic array-based memory pool.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
93 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
94 * @param capacity the initial capacity of the pool
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
95 * @return the created memory pool or \c NULL if allocation failed
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
96 */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
97 __attribute__((__warn_unused_result__))
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
98 static inline CxMempool *cxBasicMempoolCreate(size_t capacity) {
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
99 return cxMempoolCreate(capacity, NULL);
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
100 }
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
101
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
102 /**
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
103 * Destroys a memory pool including their contents.
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
104 *
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
105 * @param pool the memory pool to destroy
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
106 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
107 __attribute__((__nonnull__))
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
108 void cxMempoolDestroy(CxMempool *pool);
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
109
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
110 /**
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
111 * Sets the destructor function for a specific allocated memory object.
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
112 *
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
113 * If the memory is not managed by a UCX memory pool, the behavior is undefined.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
114 * The destructor MUST NOT free the memory.
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
115 *
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
116 * @param memory the object allocated in the pool
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
117 * @param fnc the destructor function
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
118 */
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
119 __attribute__((__nonnull__))
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
120 void cxMempoolSetDestructor(
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
121 void *memory,
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
122 cx_destructor_func fnc
727
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
123 );
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
124
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
125 /**
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
126 * Registers foreign memory with this pool.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
127 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
128 * The destructor, in contrast to memory allocated by the pool, MUST free the memory.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
129 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
130 * A small portion of memory will be allocated to register the information in the pool.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
131 * If that allocation fails, this function will return non-zero.
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
132 *
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
133 * @param pool the pool
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
134 * @param memory the object allocated in the pool
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
135 * @param destr the destructor function
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
136 * @return zero on success, non-zero on failure
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
137 */
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
138 __attribute__((__nonnull__))
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
139 int cxMempoolRegister(
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
140 CxMempool *pool,
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
141 void *memory,
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
142 cx_destructor_func destr
d92a59f5d261 improve mempool implementation
Mike Becker <universe@uap-core.de>
parents: 681
diff changeset
143 );
571
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
144
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
145 #ifdef __cplusplus
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
146 } // extern "C"
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
147 #endif
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
148
f83583a0bbac #201 - add mempool implementation
Mike Becker <universe@uap-core.de>
parents:
diff changeset
149 #endif // UCX_MEMPOOL_H

mercurial