Switched to GPLv3.
[gnupg.git] / include / memory.h
1 /* memory.h - memory allocation
2  * Copyright (C) 1998, 1999, 2000, 2001, 2005 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GNUPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef G10_MEMORY_H
21 #define G10_MEMORY_H
22
23 #ifdef M_DEBUG
24 #ifndef STR
25 #define STR(v) #v
26 #endif
27 #ifndef __riscos__
28 #define M_DBGINFO(a)        __FUNCTION__ "["__FILE__ ":"  STR(a) "]"
29 #else /* __riscos__ */
30 #define M_DBGINFO(a)         "["__FILE__ ":"  STR(a) "]"
31 #endif /* __riscos__ */
32 #define xmalloc(n)              m_debug_alloc((n), M_DBGINFO( __LINE__ ) )
33 #define xmalloc_clear(n)        m_debug_alloc_clear((n), M_DBGINFO(__LINE__) )
34 #define xmalloc_secure(n)       m_debug_alloc_secure(n), M_DBGINFO(__LINE__) )
35 #define xmalloc_secure_clear(n) m_debug_alloc_secure_clear((n), M_DBGINFO(__LINE__) )
36 #define xrealloc(n,m)           m_debug_realloc((n),(m), M_DBGINFO(__LINE__) )
37 #define xfree(n)                m_debug_free((n), M_DBGINFO(__LINE__) )
38 #define m_check(n)              m_debug_check((n), M_DBGINFO(__LINE__) )
39 /*#define m_copy(a)               m_debug_copy((a), M_DBGINFO(__LINE__) )*/
40 #define xstrdup(a)              m_debug_strdup((a), M_DBGINFO(__LINE__) )
41
42 void *m_debug_alloc( size_t n, const char *info );
43 void *m_debug_alloc_clear( size_t n, const char *info  );
44 void *m_debug_alloc_secure( size_t n, const char *info  );
45 void *m_debug_alloc_secure_clear( size_t n, const char *info  );
46 void *m_debug_realloc( void *a, size_t n, const char *info  );
47 void m_debug_free( void *p, const char *info  );
48 void m_debug_check( const void *a, const char *info );
49 /*void *m_debug_copy( const void *a, const char *info );*/
50 char *m_debug_strdup( const char *a, const char *info );
51
52 #else
53 void *xmalloc( size_t n );
54 void *xmalloc_clear( size_t n );
55 void *xmalloc_secure( size_t n );
56 void *xmalloc_secure_clear( size_t n );
57 void *xrealloc( void *a, size_t n );
58 void xfree( void *p );
59 void m_check( const void *a );
60 /*void *m_copy( const void *a );*/
61 char *xstrdup( const char * a);
62 #endif
63
64 size_t m_size( const void *a );
65 void m_print_stats(const char *prefix);
66
67 /* The follwing functions should be preferred over xmalloc_clear. */
68 void *xcalloc (size_t n, size_t m);
69 void *xcalloc_secure (size_t n, size_t m);
70
71
72 /*-- secmem.c --*/
73 int secmem_init( size_t npool );
74 void secmem_term( void );
75 void *secmem_malloc( size_t size );
76 void *secmexrealloc( void *a, size_t newsize );
77 void secmem_free( void *a );
78 int  m_is_secure( const void *p );
79 void secmem_dump_stats(void);
80 void secmem_set_flags( unsigned flags );
81 unsigned secmem_get_flags(void);
82
83
84 #define DBG_MEMORY    memory_debug_mode
85 #define DBG_MEMSTAT   memory_stat_debug_mode
86
87 #ifndef EXTERN_UNLESS_MAIN_MODULE
88 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
89 #define EXTERN_UNLESS_MAIN_MODULE extern
90 #else
91 #define EXTERN_UNLESS_MAIN_MODULE 
92 #endif
93 #endif
94 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
95 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
96
97
98
99 #endif /*G10_MEMORY_H*/