blob: 321d86a63c7211b451446d051d25309de32bc84b [file] [log] [blame]
Jameson Miller065feab2018-04-11 18:37:55 +00001#ifndef MEM_POOL_H
2#define MEM_POOL_H
3
4struct mp_block {
5 struct mp_block *next_block;
6 char *next_free;
7 char *end;
8 uintmax_t space[FLEX_ARRAY]; /* more */
9};
10
11struct mem_pool {
12 struct mp_block *mp_block;
13
14 /*
15 * The amount of available memory to grow the pool by.
16 * This size does not include the overhead for the mp_block.
17 */
18 size_t block_alloc;
19
20 /* The total amount of memory allocated by the pool. */
21 size_t pool_alloc;
22};
23
24/*
Jameson Miller158dfef2018-07-02 19:49:34 +000025 * Initialize mem_pool with specified initial size.
26 */
Elijah Newren44c7e1a2020-08-15 17:37:56 +000027void mem_pool_init(struct mem_pool *pool, size_t initial_size);
Jameson Miller158dfef2018-07-02 19:49:34 +000028
29/*
Elijah Newren44c7e1a2020-08-15 17:37:56 +000030 * Discard all the memory the memory pool is responsible for.
Jameson Miller158dfef2018-07-02 19:49:34 +000031 */
Elijah Newrenf87bf282020-08-15 17:37:57 +000032void mem_pool_discard(struct mem_pool *pool, int invalidate_memory);
Jameson Miller158dfef2018-07-02 19:49:34 +000033
34/*
Jameson Miller065feab2018-04-11 18:37:55 +000035 * Alloc memory from the mem_pool.
36 */
37void *mem_pool_alloc(struct mem_pool *pool, size_t len);
38
39/*
40 * Allocate and zero memory from the memory pool.
41 */
42void *mem_pool_calloc(struct mem_pool *pool, size_t count, size_t size);
43
Jameson Miller0e583012018-07-02 19:49:35 +000044/*
Elijah Newrena762c8c2020-08-15 17:37:55 +000045 * Allocate memory from the memory pool and copy str into it.
46 */
47char *mem_pool_strdup(struct mem_pool *pool, const char *str);
48char *mem_pool_strndup(struct mem_pool *pool, const char *str, size_t len);
49
50/*
René Scharfe8d256632024-02-25 12:39:44 +010051 * Allocate memory from the memory pool and format a string into it.
52 */
Junio C Hamano99c7de72024-06-08 11:37:47 -070053__attribute__((format (printf, 2, 3)))
René Scharfe8d256632024-02-25 12:39:44 +010054char *mem_pool_strfmt(struct mem_pool *pool, const char *fmt, ...);
55
56/*
Jameson Miller0e583012018-07-02 19:49:35 +000057 * Move the memory associated with the 'src' pool to the 'dst' pool. The 'src'
58 * pool will be empty and not contain any memory. It still needs to be free'd
59 * with a call to `mem_pool_discard`.
60 */
61void mem_pool_combine(struct mem_pool *dst, struct mem_pool *src);
62
63/*
64 * Check if a memory pointed at by 'mem' is part of the range of
65 * memory managed by the specified mem_pool.
66 */
Elijah Newrenf87bf282020-08-15 17:37:57 +000067int mem_pool_contains(struct mem_pool *pool, void *mem);
Jameson Miller0e583012018-07-02 19:49:35 +000068
Jameson Miller065feab2018-04-11 18:37:55 +000069#endif