Fix error's produced by astmm.h when standard allocators are used.
[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
34 #ifndef STANDALONE
35
36 #define __AST_DEBUG_MALLOC
37
38 #include "asterisk.h"
39
40 /* Include these now to prevent them from being needed later */
41 #include <sys/types.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #include <stdio.h>
45 #include <stdarg.h>
46
47 /* Undefine any macros */
48 #undef malloc
49 #undef calloc
50 #undef realloc
51 #undef strdup
52 #undef strndup
53 #undef asprintf
54 #undef vasprintf
55 #undef free
56
57 void *ast_std_malloc(size_t size);
58 void *ast_std_calloc(size_t nmemb, size_t size);
59 void *ast_std_realloc(void *ptr, size_t size);
60 void ast_std_free(void *ptr);
61 void ast_free_ptr(void *ptr);
62
63 void *__ast_calloc(size_t nmemb, size_t size, const char *file, int lineno, const char *func);
64 void *__ast_calloc_cache(size_t nmemb, size_t size, const char *file, int lineno, const char *func);
65 void *__ast_malloc(size_t size, const char *file, int lineno, const char *func);
66 void __ast_free(void *ptr, const char *file, int lineno, const char *func);
67 void *__ast_realloc(void *ptr, size_t size, const char *file, int lineno, const char *func);
68 char *__ast_strdup(const char *s, const char *file, int lineno, const char *func);
69 char *__ast_strndup(const char *s, size_t n, const char *file, int lineno, const char *func);
70 int __ast_asprintf(const char *file, int lineno, const char *func, char **strp, const char *format, ...)
71         __attribute__((format(printf, 5, 6)));
72 int __ast_vasprintf(char **strp, const char *format, va_list ap, const char *file, int lineno, const char *func)
73         __attribute__((format(printf, 2, 0)));
74 void __ast_mm_init_phase_1(void);
75 void __ast_mm_init_phase_2(void);
76
77 /* Redefine libc malloc to our own versions */
78
79 #ifdef WRAP_LIBC_MALLOC
80 #define calloc(a,b) \
81         __ast_calloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
82 #define malloc(a) \
83         __ast_malloc(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
84 #define free(a) \
85         __ast_free(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
86 #define realloc(a,b) \
87         __ast_realloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
88 #define strdup(a) \
89         __ast_strdup(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
90 #define strndup(a,b) \
91         __ast_strndup(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
92 #define asprintf(a, b, c...) \
93         __ast_asprintf(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, b, c)
94 #define vasprintf(a,b,c) \
95         __ast_vasprintf(a,b,c,__FILE__, __LINE__, __PRETTY_FUNCTION__)
96 #else
97 #define calloc(a,b) \
98         Do_not_use_calloc__use_ast_calloc->fail(a,b)
99 #define malloc(a) \
100         Do_not_use_malloc__use_ast_malloc->fail(a)
101 #define free(a) \
102         Do_not_use_free__use_ast_free_or_ast_std_free_for_remotely_allocated_memory->fail(a)
103 #define realloc(a,b) \
104         Do_not_use_realloc__use_ast_realloc->fail(a,b)
105 #define strdup(a) \
106         Do_not_use_strdup__use_ast_strdup->fail(a)
107 #define strndup(a,b) \
108         Do_not_use_strndup__use_ast_strndup->fail(a,b)
109 #define asprintf(a, b, c...) \
110         Do_not_use_asprintf__use_ast_asprintf->fail(a,b,c)
111 #define vasprintf(a,b,c) \
112         Do_not_use_vasprintf__use_ast_vasprintf->fail(a,b,c)
113 #endif
114
115 /* Provide our own definitions */
116
117 #define ast_calloc(a,b) \
118         __ast_calloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
119
120 #define ast_calloc_cache(a,b) \
121         __ast_calloc_cache(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
122
123 #define ast_malloc(a) \
124         __ast_malloc(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
125
126 #define ast_free(a) \
127         __ast_free(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
128
129 #define ast_realloc(a,b) \
130         __ast_realloc(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
131
132 #define ast_strdup(a) \
133         __ast_strdup(a,__FILE__, __LINE__, __PRETTY_FUNCTION__)
134
135 #define ast_strndup(a,b) \
136         __ast_strndup(a,b,__FILE__, __LINE__, __PRETTY_FUNCTION__)
137
138 #define ast_asprintf(a, b, c...) \
139         __ast_asprintf(__FILE__, __LINE__, __PRETTY_FUNCTION__, a, b, c)
140
141 #define ast_vasprintf(a,b,c) \
142         __ast_vasprintf(a,b,c,__FILE__, __LINE__, __PRETTY_FUNCTION__)
143
144 #endif /* !STANDALONE */
145
146 #else
147 #error "NEVER INCLUDE astmm.h DIRECTLY!!"
148 #endif /* _ASTERISK_ASTMM_H */
149
150 #ifdef __cplusplus
151 }
152 #endif