1 /* xmalloc.c declarations.
2 Copyright (C) 2003 Free Software Foundation, Inc.
4 This file is part of GNU Wget.
6 GNU Wget 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.
11 GNU Wget 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.
16 You should have received a copy of the GNU General Public License
17 along with Wget; if not, write to the Free Software
18 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 In addition, as a special exception, the Free Software Foundation
21 gives permission to link the code of its release of Wget with the
22 OpenSSL project's "OpenSSL" library (or with modified versions of it
23 that use the same license as the "OpenSSL" library), and distribute
24 the linked executables. You must obey the GNU General Public License
25 in all respects for all of the code used other than "OpenSSL". If you
26 modify this file, you may extend this exception to your version of the
27 file, but you are not obligated to do so. If you do not wish to do
28 so, delete this exception statement from your version. */
33 /* Define this to get Wget's builtin malloc debugging, which is
34 primitive but fairly extensive. It will make Wget somewhat slower
35 and larger, so it should be used by developers only. */
38 /* When DEBUG_MALLOC is not defined (which is normally the case), the
39 allocator identifiers are mapped to checking_* wrappers, which exit
40 Wget if malloc/realloc/strdup return NULL
42 In DEBUG_MALLOC mode, the allocators are mapped to debugging_*
43 wrappers, which also record the file and line from which the
44 allocation was attempted. At the end of the program, a detailed
45 summary of unfreed allocations is displayed.
47 *Note*: xfree(NULL) aborts in both modes. If the pointer you're
48 freeing can be NULL, use xfree_null instead. */
52 #define xmalloc checking_malloc
53 #define xmalloc0 checking_malloc0
54 #define xrealloc checking_realloc
55 #define xstrdup checking_strdup
56 #define xfree checking_free
58 void *checking_malloc PARAMS ((size_t));
59 void *checking_malloc0 PARAMS ((size_t));
60 void *checking_realloc PARAMS ((void *, size_t));
61 char *checking_strdup PARAMS ((const char *));
62 void checking_free PARAMS ((void *));
64 #else /* DEBUG_MALLOC */
66 #define xmalloc(s) debugging_malloc (s, __FILE__, __LINE__)
67 #define xmalloc0(s) debugging_malloc0 (s, __FILE__, __LINE__)
68 #define xrealloc(p, s) debugging_realloc (p, s, __FILE__, __LINE__)
69 #define xstrdup(p) debugging_strdup (p, __FILE__, __LINE__)
70 #define xfree(p) debugging_free (p, __FILE__, __LINE__)
72 void *debugging_malloc PARAMS ((size_t, const char *, int));
73 void *debugging_malloc0 PARAMS ((size_t, const char *, int));
74 void *debugging_realloc PARAMS ((void *, size_t, const char *, int));
75 char *debugging_strdup PARAMS ((const char *, const char *, int));
76 void debugging_free PARAMS ((void *, const char *, int));
78 #endif /* DEBUG_MALLOC */
80 /* Macros that interface to malloc, but know about type sizes, and
81 cast the result to the appropriate type. The casts are not
82 necessary in standard C, but Wget performs them anyway for the sake
83 of pre-standard environments and possibly C++. */
85 #define xnew(type) ((type *) xmalloc (sizeof (type)))
86 #define xnew0(type) ((type *) xmalloc0 (sizeof (type)))
87 #define xnew_array(type, len) ((type *) xmalloc ((len) * sizeof (type)))
88 #define xnew0_array(type, len) ((type *) xmalloc0 ((len) * sizeof (type)))
90 #define alloca_array(type, size) ((type *) alloca ((size) * sizeof (type)))
92 /* Free P if it is non-NULL. C requires free() to behaves this way by
93 default, but Wget's code is historically careful not to pass NULL
94 to free. This allows us to assert p!=NULL in xfree to check
95 additional errors. (But we currently don't do that!) */
96 #define xfree_null(p) if (!(p)) ; else xfree (p)
98 #endif /* XMALLOC_H */