ucx
UAP Common Extensions
mempool.h
Go to the documentation of this file.
1 /*
2  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3  *
4  * Copyright 2017 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 
38 #ifndef UCX_MEMPOOL_H
39 #define UCX_MEMPOOL_H
40 
41 #include "ucx.h"
42 #include "allocator.h"
43 #include <stddef.h>
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
52 typedef struct {
55 
57  void **data;
58 
60  size_t ndata;
61 
63  size_t size;
64 } UcxMempool;
65 
67 #define ucx_mempool_new_default() ucx_mempool_new(16)
68 
69 
81 UcxMempool *ucx_mempool_new(size_t n);
82 
93 int ucx_mempool_chcap(UcxMempool *pool, size_t newcap);
94 
103 void *ucx_mempool_malloc(UcxMempool *pool, size_t n);
115 void *ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize);
116 
129 void *ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n);
130 
144 void ucx_mempool_free(UcxMempool *pool, void *ptr);
145 
160 void ucx_mempool_destroy(UcxMempool *pool);
161 
178 void ucx_mempool_set_destr(void *ptr, ucx_destructor func);
179 
193 void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr);
194 
195 #ifdef __cplusplus
196 }
197 #endif
198 
199 #endif /* UCX_MEMPOOL_H */
200 
void ucx_mempool_free(UcxMempool *pool, void *ptr)
Frees pooled memory.
Definition: mempool.c:164
UCX mempool structure.
Definition: mempool.h:52
void ucx_mempool_destroy(UcxMempool *pool)
Destroys a memory pool.
Definition: mempool.c:186
Main UCX Header providing most common definitions.
int ucx_mempool_chcap(UcxMempool *pool, size_t newcap)
Resizes a memory pool.
Definition: mempool.c:98
void ucx_mempool_reg_destr(UcxMempool *pool, void *ptr, ucx_destructor destr)
Registers a destructor function for the specified (non-pooled) memory.
Definition: mempool.c:206
void * ucx_mempool_malloc(UcxMempool *pool, size_t n)
Allocates pooled memory.
Definition: mempool.c:113
size_t size
Memory pool size.
Definition: mempool.h:63
size_t ndata
Count of pooled memory items.
Definition: mempool.h:60
UCX allocator data structure containing memory management functions.
Definition: allocator.h:88
void * ucx_mempool_calloc(UcxMempool *pool, size_t nelem, size_t elsize)
Allocates a pooled memory array.
Definition: mempool.c:134
void ** data
List of pointers to pooled memory.
Definition: mempool.h:57
UcxMempool * ucx_mempool_new(size_t n)
Creates a memory pool with the specified initial size.
Definition: mempool.c:67
void * ucx_mempool_realloc(UcxMempool *pool, void *ptr, size_t n)
Reallocates pooled memory.
Definition: mempool.c:143
Allocator for custom memory management.
UcxAllocator * allocator
UcxAllocator based on this pool.
Definition: mempool.h:54
void ucx_mempool_set_destr(void *ptr, ucx_destructor func)
Sets a destructor function for the specified memory.
Definition: mempool.c:202
void(* ucx_destructor)(void *)
A function pointer to a destructor function.
Definition: ucx.h:72