lib/xmalloc.c

   1 /* xmalloc.c -- malloc with out of memory checking
   2
   3    Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2003,
   4    1999, 2000, 2002, 2003 Free Software Foundation, Inc.
   5
   6    This program 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, or (at your option)
   9    any later version.
  10
  11    This program 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 Foundation,
  18    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  19
  20 #if HAVE_CONFIG_H
  21 # include <config.h>
  22 #endif
  23
  24 #include "xalloc.h"
  25
  26 #include <stdbool.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include "gettext.h"
  31 #define _(msgid) gettext (msgid)
  32 #define N_(msgid) msgid
  33
  34 #include "error.h"
  35 #include "exitfail.h"
  36
  37 #ifndef SIZE_MAX
  38 # define SIZE_MAX ((size_t) -1)
  39 #endif
  40
  41 #ifndef HAVE_MALLOC
  42 "you must run the autoconf test for a GNU libc compatible malloc"
  43 #endif
  44
  45 #ifndef HAVE_REALLOC
  46 "you must run the autoconf test for a GNU libc compatible realloc"
  47 #endif
  48
  49 /* If non NULL, call this function when memory is exhausted. */
  50 void (*xalloc_fail_func) (void) = 0;
  51
  52 /* Return true if array of N objects, each of size S, cannot exist due
  53    to arithmetic overflow.  S must be nonzero.  */
  54
  55 static inline bool
  56 array_size_overflow (size_t n, size_t s)
  57 {
  58   return SIZE_MAX / s < n;
  59 }
  60
  61 /* If XALLOC_FAIL_FUNC is NULL, or does return, display this message
  62    before exiting when memory is exhausted.  Goes through gettext. */
  63 char const xalloc_msg_memory_exhausted[] = N_("memory exhausted");
  64
  65 void
  66 xalloc_die (void)
  67 {
  68   if (xalloc_fail_func)
  69     (*xalloc_fail_func) ();
  70   error (exit_failure, 0, "%s", _(xalloc_msg_memory_exhausted));
  71   /* The `noreturn' cannot be given to error, since it may return if
  72      its first argument is 0.  To help compilers understand the
  73      xalloc_die does terminate, call abort.  */
  74   abort ();
  75 }
  76
  77 /* Allocate an array of N objects, each with S bytes of memory,
  78    dynamically, with error checking.  S must be nonzero.  */
  79
  80 inline void *
  81 xnmalloc (size_t n, size_t s)
  82 {
  83   void *p;
  84   if (array_size_overflow (n, s) || ! (p = malloc (n * s)))
  85     xalloc_die ();
  86   return p;
  87 }
  88
  89 /* Allocate N bytes of memory dynamically, with error checking.  */
  90
  91 void *
  92 xmalloc (size_t n)
  93 {
  94   return xnmalloc (n, 1);
  95 }
  96
  97 /* Change the size of an allocated block of memory P to an array of N
  98    objects each of S bytes, with error checking.  S must be nonzero.  */
  99
 100 inline void *
 101 xnrealloc (void *p, size_t n, size_t s)
 102 {
 103   if (array_size_overflow (n, s) || ! (p = realloc (p, n * s)))
 104     xalloc_die ();
 105   return p;
 106 }
 107
 108 /* Change the size of an allocated block of memory P to N bytes,
 109    with error checking.  */
 110
 111 void *
 112 xrealloc (void *p, size_t n)
 113 {
 114   return xnrealloc (p, n, 1);
 115 }
 116
 117 /* Allocate S bytes of zeroed memory dynamically, with error checking.
 118    There's no need for xnzalloc (N, S), since it would be equivalent
 119    to xcalloc (N, S).  */
 120
 121 void *
 122 xzalloc (size_t s)
 123 {
 124   return memset (xmalloc (s), 0, s);
 125 }
 126
 127 /* Allocate zeroed memory for N elements of S bytes, with error
 128    checking.  S must be nonzero.  */
 129
 130 void *
 131 xcalloc (size_t n, size_t s)
 132 {
 133   void *p;
 134   /* Test for overflow, since some calloc implementations don't have
 135      proper overflow checks.  */
 136   if (array_size_overflow (n, s) || ! (p = calloc (n, s)))
 137     xalloc_die ();
 138   return p;
 139 }
 140
 141 /* Clone an object P of size S, with error checking.  There's no need
 142    for xnclone (P, N, S), since xclone (P, N * S) works without any
 143    need for an arithmetic overflow check.  */
 144
 145 void *
 146 xclone (void const *p, size_t s)
 147 {
 148   return memcpy (xmalloc (s), p, s);
 149 }