* gpg.sgml: Note that --pgp8 does not include SHA224. Clarify that
[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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef G10_MEMORY_H
23 #define G10_MEMORY_H
24
25 #ifdef M_DEBUG
26 #ifndef STR
27 #define STR(v) #v
28 #endif
29 #ifndef __riscos__
30 #define M_DBGINFO(a)        __FUNCTION__ "["__FILE__ ":"  STR(a) "]"
31 #else /* __riscos__ */
32 #define M_DBGINFO(a)         "["__FILE__ ":"  STR(a) "]"
33 #endif /* __riscos__ */
34 #define xmalloc(n)              m_debug_alloc((n), M_DBGINFO( __LINE__ ) )
35 #define xmalloc_clear(n)        m_debug_alloc_clear((n), M_DBGINFO(__LINE__) )
36 #define xmalloc_secure(n)       m_debug_alloc_secure(n), M_DBGINFO(__LINE__) )
37 #define xmalloc_secure_clear(n) m_debug_alloc_secure_clear((n), M_DBGINFO(__LINE__) )
38 #define xrealloc(n,m)           m_debug_realloc((n),(m), M_DBGINFO(__LINE__) )
39 #define xfree(n)                m_debug_free((n), M_DBGINFO(__LINE__) )
40 #define m_check(n)              m_debug_check((n), M_DBGINFO(__LINE__) )
41 /*#define m_copy(a)               m_debug_copy((a), M_DBGINFO(__LINE__) )*/
42 #define xstrdup(a)              m_debug_strdup((a), M_DBGINFO(__LINE__) )
43
44 void *m_debug_alloc( size_t n, const char *info );
45 void *m_debug_alloc_clear( size_t n, const char *info  );
46 void *m_debug_alloc_secure( size_t n, const char *info  );
47 void *m_debug_alloc_secure_clear( size_t n, const char *info  );
48 void *m_debug_realloc( void *a, size_t n, const char *info  );
49 void m_debug_free( void *p, const char *info  );
50 void m_debug_check( const void *a, const char *info );
51 /*void *m_debug_copy( const void *a, const char *info );*/
52 char *m_debug_strdup( const char *a, const char *info );
53
54 #else
55 void *xmalloc( size_t n );
56 void *xmalloc_clear( size_t n );
57 void *xmalloc_secure( size_t n );
58 void *xmalloc_secure_clear( size_t n );
59 void *xrealloc( void *a, size_t n );
60 void xfree( void *p );
61 void m_check( const void *a );
62 /*void *m_copy( const void *a );*/
63 char *xstrdup( const char * a);
64 #endif
65
66 size_t m_size( const void *a );
67 void m_print_stats(const char *prefix);
68
69 /* The follwing functions should be preferred over xmalloc_clear. */
70 void *xcalloc (size_t n, size_t m);
71 void *xcalloc_secure (size_t n, size_t m);
72
73
74 /*-- secmem.c --*/
75 int secmem_init( size_t npool );
76 void secmem_term( void );
77 void *secmem_malloc( size_t size );
78 void *secmexrealloc( void *a, size_t newsize );
79 void secmem_free( void *a );
80 int  m_is_secure( const void *p );
81 void secmem_dump_stats(void);
82 void secmem_set_flags( unsigned flags );
83 unsigned secmem_get_flags(void);
84
85
86 #define DBG_MEMORY    memory_debug_mode
87 #define DBG_MEMSTAT   memory_stat_debug_mode
88
89 #ifndef EXTERN_UNLESS_MAIN_MODULE
90 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
91 #define EXTERN_UNLESS_MAIN_MODULE extern
92 #else
93 #define EXTERN_UNLESS_MAIN_MODULE 
94 #endif
95 #endif
96 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
97 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
98
99
100
101 #endif /*G10_MEMORY_H*/