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 <http://www.eyrie.org/~eagle/software/rra-c-util/>.
   6  *
   7  * Copyright 2010, 2012, 2013
   8  *     The Board of Trustees of the Leland Stanford Junior University
   9  * Copyright (c) 2004, 2005, 2006
  10  *     by Internet Systems Consortium, Inc. ("ISC")
  11  * Copyright (c) 1991, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
  12  *     2002, 2003 by The Internet Software Consortium and Rich Salz
  13  *
  14  * This code is derived from software contributed to the Internet Software
  15  * Consortium by Rich Salz.
  16  *
  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.
  20  *
  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.
  28  */
  29
  30 #ifndef UTIL_XMALLOC_H
  31 #define UTIL_XMALLOC_H 1
  32
  33 #include <config.h>
  34 #include <portable/macros.h>
  35
  36 #include <stdarg.h>
  37 #include <stddef.h>
  38
  39 /*
  40  * The functions are actually macros so that we can pick up the file and line
  41  * number information for debugging error messages without the user having to
  42  * pass those in every time.
  43  */
  44 #define xcalloc(n, size)        x_calloc((n), (size), __FILE__, __LINE__)
  45 #define xmalloc(size)           x_malloc((size), __FILE__, __LINE__)
  46 #define xrealloc(p, size)       x_realloc((p), (size), __FILE__, __LINE__)
  47 #define xstrdup(p)              x_strdup((p), __FILE__, __LINE__)
  48 #define xstrndup(p, size)       x_strndup((p), (size), __FILE__, __LINE__)
  49 #define xvasprintf(p, f, a)     x_vasprintf((p), (f), (a), __FILE__, __LINE__)
  50
  51 /*
  52  * asprintf is a special case since it takes variable arguments.  If we have
  53  * support for variadic macros, we can still pass in the file and line and
  54  * just need to put them somewhere else in the argument list than last.
  55  * Otherwise, just call x_asprintf directly.  This means that the number of
  56  * arguments x_asprintf takes must vary depending on whether variadic macros
  57  * are supported.
  58  */
  59 #ifdef HAVE_C99_VAMACROS
  60 # define xasprintf(p, f, ...) \
  61     x_asprintf((p), __FILE__, __LINE__, (f), __VA_ARGS__)
  62 #elif HAVE_GNU_VAMACROS
  63 # define xasprintf(p, f, args...) \
  64     x_asprintf((p), __FILE__, __LINE__, (f), args)
  65 #else
  66 # define xasprintf x_asprintf
  67 #endif
  68
  69 BEGIN_DECLS
  70
  71 /* Default to a hidden visibility for all util functions. */
  72 #pragma GCC visibility push(hidden)
  73
  74 /*
  75  * Last two arguments are always file and line number.  These are internal
  76  * implementations that should not be called directly.
  77  */
  78 void *x_calloc(size_t, size_t, const char *, int)
  79     __attribute__((__alloc_size__(1, 2), __malloc__, __nonnull__));
  80 void *x_malloc(size_t, const char *, int)
  81     __attribute__((__alloc_size__(1), __malloc__, __nonnull__));
  82 void *x_realloc(void *, size_t, const char *, int)
  83     __attribute__((__alloc_size__(2), __malloc__, __nonnull__(3)));
  84 char *x_strdup(const char *, const char *, int)
  85     __attribute__((__malloc__, __nonnull__));
  86 char *x_strndup(const char *, size_t, const char *, int)
  87     __attribute__((__malloc__, __nonnull__));
  88 void x_vasprintf(char **, const char *, va_list, const char *, int)
  89     __attribute__((__nonnull__));
  90
  91 /* asprintf special case. */
  92 #if HAVE_C99_VAMACROS || HAVE_GNU_VAMACROS
  93 void x_asprintf(char **, const char *, int, const char *, ...)
  94     __attribute__((__nonnull__, __format__(printf, 4, 5)));
  95 #else
  96 void x_asprintf(char **, const char *, ...)
  97     __attribute__((__nonnull__, __format__(printf, 2, 3)));
  98 #endif
  99
 100 /*
 101  * Failure handler takes the function, the size, the file, and the line.  The
 102  * size will be zero if the failure was due to some failure in snprintf
 103  * instead of a memory allocation failure.
 104  */
 105 typedef void (*xmalloc_handler_type)(const char *, size_t, const char *, int);
 106
 107 /* The default error handler. */
 108 void xmalloc_fail(const char *, size_t, const char *, int)
 109     __attribute__((__nonnull__));
 110
 111 /*
 112  * Assign to this variable to choose a handler other than the default, which
 113  * just calls sysdie.
 114  */
 115 extern xmalloc_handler_type xmalloc_error_handler;
 116
 117 /* Undo default visibility change. */
 118 #pragma GCC visibility pop
 119
 120 END_DECLS
 121
 122 #endif /* UTIL_XMALLOC_H */