Fix naming mismatch of allocator functions.
[asterisk/asterisk.git] / include / asterisk / astmm.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Asterisk memory usage debugging
21  * This file provides headers for MALLOC_DEBUG, a define used for tracking down
22  * memory leaks.  It should never be \#included directly; always use the
23  * MALLOC_DEBUG definition in menuselect to activate those functions.
24  */
25
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 #ifndef _ASTERISK_ASTMM_H
32 #define _ASTERISK_ASTMM_H
33 /* IWYU pragma: private, include "asterisk/utils.h" */
34
35 #ifndef STANDALONE
36
37 #define __AST_DEBUG_MALLOC
38
39 #include "asterisk.h"
40
41 /* Include these now to prevent them from being needed later */
42 #include <sys/types.h>
43 #include <stdlib.h>
44 #include <string.h>
45 #include <stdio.h>
46 #include <stdarg.h>
47
48 void *ast_std_malloc(size_t size);
49 void *ast_std_calloc(size_t nmemb, size_t size);
50 void *ast_std_realloc(void *ptr, size_t size);
51 void ast_std_free(void *ptr);
52 void ast_free_ptr(void *ptr);
53
54 void *__ast_calloc(size_t nmemb, size_t size, const char *file, int lineno, const char *func);
55 void *__ast_calloc_cache(size_t nmemb, size_t size, const char *file, int lineno, const char *func);
56 void *__ast_malloc(size_t size, const char *file, int lineno, const char *func);
57 void __ast_free(void *ptr, const char *file, int lineno, const char *func);
58 void *__ast_realloc(void *ptr, size_t size, const char *file, int lineno, const char *func);
59 char *__ast_strdup(const char *s, const char *file, int lineno, const char *func);
60 char *__ast_strndup(const char *s, size_t n, const char *file, int lineno, const char *func);
61 int __ast_asprintf(const char *file, int lineno, const char *func, char **strp, const char *format, ...)
62         __attribute__((format(printf, 5, 6)));
63 int __ast_vasprintf(char **strp, const char *format, va_list ap, const char *file, int lineno, const char *func)
64         __attribute__((format(printf, 2, 0)));
65 void __ast_mm_init_phase_1(void);
66 void __ast_mm_init_phase_2(void);
67
68 /*!
69  * \brief ASTMM_LIBC can be defined to control the meaning of standard allocators.
70  *
71  * \note The standard allocators effected by this compiler define are:
72  *    malloc, calloc, realloc, strdup, strndup, asprintf, vasprintf and free.
73  *
74  * @{
75  */
76
77 /*!
78  * \brief Produce compiler errors if standard allocators are used.
79  *
80  * \note This is the default option, and in most cases the correct option.
81  * Any use of standard allocators will cause an error, even if those uses
82  * are in unused static inline header functions.
83  */
84 #define ASTMM_BLOCK    0
85
86 /*!
87  * \brief Redirect standard allocators to use Asterisk functions.
88  *
89  * \note This option is used in some cases instead of changing the
90  * existing source to use Asterisk functions.  New code should
91  * generally avoid this option, except where it's needed to work
92  * with situations where switching the code is unreasonable, such
93  * as output from code generators that are hard coded to use
94  * standard functions.
95  */
96 #define ASTMM_REDIRECT 1
97
98 /*!
99  * \brief Standard allocators are used directly.
100  *
101  * \note This option is needed when including 3rd party headers with calls
102  * to standard allocators from inline functions.  Using ASTMM_REDIRECT in
103  * this situation could result in an object being allocated by malloc and
104  * freed by ast_free, or the reverse.
105  */
106 #define ASTMM_IGNORE   2
107
108 /*!
109  * }@
110  */
111
112 #if !defined(ASTMM_LIBC)
113 /* BLOCK libc allocators by default. */
114 #define ASTMM_LIBC ASTMM_BLOCK
115 #endif
116
117 #if ASTMM_LIBC == ASTMM_IGNORE
118 /* Don't touch the libc functions. */
119 #else
120
121 /* Undefine any macros */
122 #undef malloc
123 #undef calloc
124 #undef realloc
125 #undef strdup
126 #undef strndup
127 #undef asprintf
128 #undef vasprintf
129 #undef free
130
131 #if ASTMM_LIBC == ASTMM_REDIRECT
132
133 /* Redefine libc functions to our own versions */
134 #define calloc(a,b) \
135         __ast_calloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
136 #define malloc(a) \
137         __ast_malloc(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
138 #define free(a) \
139         __ast_free(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
140 #define realloc(a,b) \
141         __ast_realloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
142 #define strdup(a) \
143         __ast_strdup(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
144 #define strndup(a,b) \
145         __ast_strndup(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
146 #define asprintf(a, b, c...) \
147         __ast_asprintf(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, b, c)
148 #define vasprintf(a,b,c) \
149         __ast_vasprintf(a,b,c,__FILE__, __LINE__, __PRETTY_FUNCTION__)
150
151 #elif ASTMM_LIBC == ASTMM_BLOCK
152
153 /* Redefine libc functions to cause compile errors */
154 #define calloc(a,b) \
155         Do_not_use_calloc__use_ast_calloc->fail(a,b)
156 #define malloc(a) \
157         Do_not_use_malloc__use_ast_malloc->fail(a)
158 #define free(a) \
159         Do_not_use_free__use_ast_free_or_ast_std_free_for_remotely_allocated_memory->fail(a)
160 #define realloc(a,b) \
161         Do_not_use_realloc__use_ast_realloc->fail(a,b)
162 #define strdup(a) \
163         Do_not_use_strdup__use_ast_strdup->fail(a)
164 #define strndup(a,b) \
165         Do_not_use_strndup__use_ast_strndup->fail(a,b)
166 #define asprintf(a, b, c...) \
167         Do_not_use_asprintf__use_ast_asprintf->fail(a,b,c)
168 #define vasprintf(a,b,c) \
169         Do_not_use_vasprintf__use_ast_vasprintf->fail(a,b,c)
170
171 #else
172 #error "Unacceptable value for the macro ASTMM_LIBC"
173 #endif
174
175 #endif
176
177 /* Provide our own definition for ast_free */
178
179 #define ast_free(a) \
180         __ast_free(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
181
182 #endif /* !STANDALONE */
183
184 #else
185 #error "NEVER INCLUDE astmm.h DIRECTLY!!"
186 #endif /* _ASTERISK_ASTMM_H */
187
188 #ifdef __cplusplus
189 }
190 #endif