util/xmalloc.h

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