2 * Prototypes for malloc routines with failure handling.
4 * The canonical version of this file is maintained in the rra-c-util package,
5 * which can be found at <https://www.eyrie.org/~eagle/software/rra-c-util/>.
7 * Written by Russ Allbery <eagle@eyrie.org>
8 * Copyright 2022 Russ Allbery <eagle@eyrie.org>
9 * Copyright 2010, 2012-2014
10 * The Board of Trustees of the Leland Stanford Junior University
11 * Copyright 2004-2006 Internet Systems Consortium, Inc. ("ISC")
12 * Copyright 1991, 1994-2003 The Internet Software Consortium and Rich Salz
14 * This code is derived from software contributed to the Internet Software
15 * Consortium by Rich Salz.
17 * Permission to use, copy, modify, and distribute this software for any
18 * purpose with or without fee is hereby granted, provided that the above
19 * copyright notice and this permission notice appear in all copies.
21 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
22 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
23 * AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
24 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
25 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
26 * OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
27 * PERFORMANCE OF THIS SOFTWARE.
29 * SPDX-License-Identifier: ISC
32 #ifndef UTIL_XMALLOC_H
33 #define UTIL_XMALLOC_H 1
36 #include <portable/macros.h>
43 * The functions are actually macros so that we can pick up the file and line
44 * number information for debugging error messages without the user having to
45 * pass those in every time.
47 #define xcalloc(n, size) x_calloc((n), (size), __FILE__, __LINE__)
48 #define xmalloc(size) x_malloc((size), __FILE__, __LINE__)
49 #define xrealloc(p, size) x_realloc((p), (size), __FILE__, __LINE__)
50 #define xstrdup(p) x_strdup((p), __FILE__, __LINE__)
51 #define xstrndup(p, size) x_strndup((p), (size), __FILE__, __LINE__)
52 #define xvasprintf(p, f, a) x_vasprintf((p), (f), (a), __FILE__, __LINE__)
53 #define xreallocarray(p, n, size) \
54 x_reallocarray((p), (n), (size), __FILE__, __LINE__)
57 * asprintf is a special case since it takes variable arguments. If we have
58 * support for variadic macros, we can still pass in the file and line and
59 * just need to put them somewhere else in the argument list than last.
60 * Otherwise, just call x_asprintf directly. This means that the number of
61 * arguments x_asprintf takes must vary depending on whether variadic macros
64 #ifdef HAVE_C99_VAMACROS
65 # define xasprintf(p, f, ...) \
66 x_asprintf((p), __FILE__, __LINE__, (f), __VA_ARGS__)
67 #elif HAVE_GNU_VAMACROS
68 # define xasprintf(p, f, args...) \
69 x_asprintf((p), __FILE__, __LINE__, (f), args)
71 # define xasprintf x_asprintf
76 /* Default to a hidden visibility for all util functions. */
77 #pragma GCC visibility push(hidden)
80 * Last two arguments are always file and line number. These are internal
81 * implementations that should not be called directly.
83 void *x_calloc(size_t, size_t, const char *, int)
84 __attribute__((__alloc_size__(1, 2), __malloc__(free), __nonnull__));
85 void *x_malloc(size_t, const char *, int)
86 __attribute__((__alloc_size__(1), __malloc__(free), __nonnull__));
87 void *x_realloc(void *, size_t, const char *, int)
88 __attribute__((__alloc_size__(2), __malloc__(free), __nonnull__(3)));
89 void *x_reallocarray(void *, size_t, size_t, const char *, int)
90 __attribute__((__alloc_size__(2, 3), __malloc__(free), __nonnull__(4)));
91 char *x_strdup(const char *, const char *, int)
92 __attribute__((__malloc__(free), __nonnull__));
93 char *x_strndup(const char *, size_t, const char *, int)
94 __attribute__((__malloc__(free), __nonnull__));
95 void x_vasprintf(char **, const char *, va_list, const char *, int)
96 __attribute__((__nonnull__, __format__(printf, 2, 0)));
98 /* asprintf special case. */
99 #if HAVE_C99_VAMACROS || HAVE_GNU_VAMACROS
100 void x_asprintf(char **, const char *, int, const char *, ...)
101 __attribute__((__nonnull__, __format__(printf, 4, 5)));
103 void x_asprintf(char **, const char *, ...)
104 __attribute__((__nonnull__, __format__(printf, 2, 3)));
108 * Failure handler takes the function, the size, the file, and the line. The
109 * size will be zero if the failure was due to some failure in snprintf
110 * instead of a memory allocation failure.
112 typedef void (*xmalloc_handler_type)(const char *, size_t, const char *, int);
114 /* The default error handler. */
115 void xmalloc_fail(const char *, size_t, const char *, int)
116 __attribute__((__nonnull__, __noreturn__));
119 * Assign to this variable to choose a handler other than the default, which
122 extern xmalloc_handler_type xmalloc_error_handler;
124 /* Undo default visibility change. */
125 #pragma GCC visibility pop
129 #endif /* UTIL_XMALLOC_H */