Updated FSF's address.
[gnupg.git] / include / memory.h
1 /* memory.h - memory allocation
2  *      Copyright (C) 1998, 1999, 2000, 2001 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 #error this file should not be used anymore
26
27 #ifdef M_DEBUG
28 #ifndef STR
29 #define STR(v) #v
30 #endif
31 #ifndef __riscos__
32 #define M_DBGINFO(a)        __FUNCTION__ "["__FILE__ ":"  STR(a) "]"
33 #else /* __riscos__ */
34 #define M_DBGINFO(a)         "["__FILE__ ":"  STR(a) "]"
35 #endif /* __riscos__ */
36 #define m_alloc(n)              m_debug_alloc((n), M_DBGINFO( __LINE__ ) )
37 #define m_alloc_clear(n)        m_debug_alloc_clear((n), M_DBGINFO(__LINE__) )
38 #define m_alloc_secure(n)       m_debug_alloc((n), M_DBGINFO(__LINE__) )
39 #define m_alloc_secure_clear(n) m_debug_alloc_secure_clear((n), M_DBGINFO(__LINE__) )
40 #define m_realloc(n,m)          m_debug_realloc((n),(m), M_DBGINFO(__LINE__) )
41 #define m_free(n)               m_debug_free((n), M_DBGINFO(__LINE__) )
42 #define m_check(n)              m_debug_check((n), M_DBGINFO(__LINE__) )
43 /*#define m_copy(a)               m_debug_copy((a), M_DBGINFO(__LINE__) )*/
44 #define m_strdup(a)             m_debug_strdup((a), M_DBGINFO(__LINE__) )
45
46 void *m_debug_alloc( size_t n, const char *info );
47 void *m_debug_alloc_clear( size_t n, const char *info  );
48 void *m_debug_alloc_secure( size_t n, const char *info  );
49 void *m_debug_alloc_secure_clear( size_t n, const char *info  );
50 void *m_debug_realloc( void *a, size_t n, const char *info  );
51 void m_debug_free( void *p, const char *info  );
52 void m_debug_check( const void *a, const char *info );
53 /*void *m_debug_copy( const void *a, const char *info );*/
54 char *m_debug_strdup( const char *a, const char *info );
55
56 #else
57 void *m_alloc( size_t n );
58 void *m_alloc_clear( size_t n );
59 void *m_alloc_secure( size_t n );
60 void *m_alloc_secure_clear( size_t n );
61 void *m_realloc( void *a, size_t n );
62 void m_free( void *p );
63 void m_check( const void *a );
64 /*void *m_copy( const void *a );*/
65 char *m_strdup( const char * a);
66 #endif
67
68 size_t m_size( const void *a );
69 void m_print_stats(const char *prefix);
70
71 /*-- secmem.c --*/
72 void secmem_init( size_t npool );
73 void secmem_term( void );
74 void *secmem_malloc( size_t size );
75 void *secmem_realloc( void *a, size_t newsize );
76 void secmem_free( void *a );
77 int  m_is_secure( const void *p );
78 void secmem_dump_stats(void);
79 void secmem_set_flags( unsigned flags );
80 unsigned secmem_get_flags(void);
81
82
83 #define DBG_MEMORY    memory_debug_mode
84 #define DBG_MEMSTAT   memory_stat_debug_mode
85
86 #ifndef EXTERN_UNLESS_MAIN_MODULE
87 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
88 #define EXTERN_UNLESS_MAIN_MODULE extern
89 #else
90 #define EXTERN_UNLESS_MAIN_MODULE 
91 #endif
92 #endif
93 EXTERN_UNLESS_MAIN_MODULE int memory_debug_mode;
94 EXTERN_UNLESS_MAIN_MODULE int memory_stat_debug_mode;
95
96 #endif /*G10_MEMORY_H*/