1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \file mempattern.h
*
* \author Marek Vavrusa <marek.vavrusa@nic.cz>
*
* \brief Memory allocation related functions.
*
* \addtogroup alloc
* @{
*/
#ifndef _KNOTD_COMMON_MALLOC_H_
#define _KNOTD_COMMON_MALLOC_H_
#include <stddef.h>
/* Memory allocation function prototypes. */
typedef void* (*mm_alloc_t)(void* ctx, size_t len);
typedef void (*mm_free_t)(void *p);
typedef void (*mm_flush_t)(void *p);
/* Memory allocation context. */
typedef struct mm_ctx {
void *ctx; /* \note Must be first */
mm_alloc_t alloc;
mm_free_t free;
} mm_ctx_t;
/*! \brief Initialize default memory allocation context. */
void mm_ctx_init(mm_ctx_t *mm);
/*! \brief Allocate memory or die. */
void* xmalloc(size_t l);
/*! \brief Reallocate memory or die. */
void *xrealloc(void *p, size_t l);
/*!
* \brief Reserve new or trim excessive memory.
*
* \param p Double-pointer to memory region.
* \param tlen Memory unit (f.e. sizeof(int) for int* array)
* \param min Minimum number of items required.
* \param allow Maximum extra items to keep (for trimming).
* \param reserved Pointer to number of already reserved items.
*
* \note Example usage:
* char *buf = NULL; size_t len = 0;
* if (mreserve(&buf, sizeof(char), 6, 0, &len) == 0) {
* memcpy(buf, "hello", strlen("hello");
* if (mreserve(&buf, sizeof(char), 20, 0, &len) == 0) {
* strncat(buf, "!", 1);
* mreserve(&buf, sizeof(char), strlen("hello!")+1, 0, &len);
* }
* }
* free(buf);
*
* \retval 0 on success.
* \retval -1 on error.
*
* \note Memory region will be left untouched if function fails.
*/
int mreserve(char **p, size_t tlen, size_t min, size_t allow, size_t *reserved);
/*!
* \brief Format string and take care of allocating memory.
*
* \note sprintf(3) manual page reference implementation.
*
* \param fmt Message format.
* \return formatted message or NULL.
*/
char* sprintf_alloc(const char *fmt, ...);
/*!
* \brief Create new string from a concatenation of s1 and s2.
*
* \param s1 First string.
* \param s2 Second string.
*
* \retval Newly allocated string on success.
* \retval NULL on error.
*/
char* strcdup(const char *s1, const char *s2);
/*! \brief Print usage statistics.
*
* \note This function has destructor attribute set if MEM_DEBUG is enabled.
*
* \warning Not all printed statistics are available on every OS,
* consult manual page for getrusage(2).
*/
void usage_dump();
#endif // _KNOTD_COMMON_MALLOC_H_
/*! @} */
|
