1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28 /**
29 * \file mempool.h
30 * \brief Interface for memory pool implementations.
31 * \author Mike Becker
32 * \author Olaf Wintermann
33 * \version 3.0
34 * \copyright 2-Clause BSD License
35 */
36
37 #ifndef UCX_MEMPOOL_H
38 #define UCX_MEMPOOL_H
39
40 #include "common.h"
41 #include "allocator.h"
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 /**
48 * Memory pool class type.
49 */
50 typedef struct cx_mempool_class_s cx_mempool_class;
51
52 /**
53 * The basic structure of a memory pool.
54 * Should be the first member of an actual memory pool implementation.
55 */
56 struct cx_mempool_s {
57 /**
58 * The pool class definition.
59 */
60 cx_mempool_class *cl;
61 /**
62 * The provided allocator.
63 */
64 CxAllocator const *allocator;
65 };
66
67 /**
68 * Common type for all memory pool implementations.
69 */
70 typedef struct cx_mempool_s CxMempool;
71
72 /**
73 * The class definition for a memory pool.
74 */
75 struct cx_mempool_class_s {
76 /** Member function for destroying the pool. */
77 __attribute__((__nonnull__))
78 void (*destroy)(CxMempool *pool);
79
80 /** Member function for setting a destructor. */
81 __attribute__((__nonnull__))
82 void (*set_destructor)(
83 CxMempool *pool,
84 void *memory,
85 cx_destructor_func fnc
86 );
87 };
88
89
90 /**
91 * Destroys a memory pool including their contents.
92 *
93 * @param pool the memory pool to destroy
94 */
95 __attribute__((__nonnull__))
96 static inline void cxMempoolDestroy(CxMempool *pool) {
97 pool->cl->destroy(pool);
98 }
99
100 /**
101 * Sets a destructor function for an allocated memory object.
102 *
103 * If the memory is not managed by the pool, the behavior is undefined.
104 *
105 * @param pool the pool
106 * @param memory the objected allocated in the pool
107 * @param fnc the destructor function
108 */
109 __attribute__((__nonnull__))
110 static inline void cxMempoolSetDestructor(
111 CxMempool *pool,
112 void *memory,
113 cx_destructor_func fnc
114 ) {
115 pool->cl->set_destructor(pool, memory, fnc);
116 }
117
118 #ifdef __cplusplus
119 } // extern "C"
120 #endif
121
122 #endif // UCX_MEMPOOL_H
123