annotate lib/xmalloc.c @ 4554:5a1e7c84e9cd

Use three spaces, rather than tab, after '#' in shell-script copyright notices. Suggested by Bruno Haible.
author Paul Eggert <eggert@cs.ucla.edu>
date Fri, 15 Aug 2003 18:04:34 +0000 (2003-08-15)
parents fd6696a97000
children ce37d22a271f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
1 /* xmalloc.c -- malloc with out of memory checking
4397
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4000
diff changeset
2
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4000
diff changeset
3 Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4000
diff changeset
4 1999, 2000, 2002, 2003 Free Software Foundation, Inc.
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
5
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
9 any later version.
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
10
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
14 GNU General Public License for more details.
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
15
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
649
89f4c1937ac7 update FSF address in copyright and remove any trailing blanks
Jim Meyering <jim@meyering.net>
parents: 399
diff changeset
17 along with this program; if not, write to the Free Software Foundation,
89f4c1937ac7 update FSF address in copyright and remove any trailing blanks
Jim Meyering <jim@meyering.net>
parents: 399
diff changeset
18 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
19
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
20 #if HAVE_CONFIG_H
653
b63f146fd963 indent cpp-directives
Jim Meyering <jim@meyering.net>
parents: 649
diff changeset
21 # include <config.h>
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
22 #endif
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
23
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
24 #include <sys/types.h>
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
25
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
26 #if STDC_HEADERS
653
b63f146fd963 indent cpp-directives
Jim Meyering <jim@meyering.net>
parents: 649
diff changeset
27 # include <stdlib.h>
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
28 #else
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
29 void *calloc ();
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
30 void *malloc ();
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
31 void *realloc ();
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
32 void free ();
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
33 #endif
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
34
3966
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3130
diff changeset
35 #include "gettext.h"
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3130
diff changeset
36 #define _(msgid) gettext (msgid)
22d3032f0239 Include gettext.h instead of <libintl.h> with #ifdefs.
Bruno Haible <bruno@clisp.org>
parents: 3130
diff changeset
37 #define N_(msgid) msgid
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
38
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
39 #include "error.h"
4473
fd6696a97000 Sync with coreutils xalloc.h, xmalloc.c, xmemcoll.h, xmemcoll.c.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4397
diff changeset
40 #include "exitfail.h"
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
41 #include "xalloc.h"
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
42
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
43 #ifndef EXIT_FAILURE
653
b63f146fd963 indent cpp-directives
Jim Meyering <jim@meyering.net>
parents: 649
diff changeset
44 # define EXIT_FAILURE 1
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
45 #endif
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
46
4000
592de7dbfd00 Comment tweaks.
Bruno Haible <bruno@clisp.org>
parents: 3985
diff changeset
47 /* The following tests require AC_PREREQ(2.54). */
592de7dbfd00 Comment tweaks.
Bruno Haible <bruno@clisp.org>
parents: 3985
diff changeset
48
3985
f01511388a8f Adjust to work with new autoconf macros, AC_FUNC_MALLOC
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
49 #ifndef HAVE_MALLOC
4000
592de7dbfd00 Comment tweaks.
Bruno Haible <bruno@clisp.org>
parents: 3985
diff changeset
50 "you must run the autoconf test for a GNU libc compatible malloc"
1090
94c957144330 make sure autoconf tests have been run
Jim Meyering <jim@meyering.net>
parents: 1088
diff changeset
51 #endif
94c957144330 make sure autoconf tests have been run
Jim Meyering <jim@meyering.net>
parents: 1088
diff changeset
52
3985
f01511388a8f Adjust to work with new autoconf macros, AC_FUNC_MALLOC
Jim Meyering <jim@meyering.net>
parents: 3966
diff changeset
53 #ifndef HAVE_REALLOC
4000
592de7dbfd00 Comment tweaks.
Bruno Haible <bruno@clisp.org>
parents: 3985
diff changeset
54 "you must run the autoconf test for a GNU libc compatible realloc"
1090
94c957144330 make sure autoconf tests have been run
Jim Meyering <jim@meyering.net>
parents: 1088
diff changeset
55 #endif
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
56
1604
5ec174d20066 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1557
diff changeset
57 /* If non NULL, call this function when memory is exhausted. */
4397
c6450308f123 Assume C89, so PARAMS isn't needed.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4000
diff changeset
58 void (*xalloc_fail_func) (void) = 0;
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
59
1604
5ec174d20066 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1557
diff changeset
60 /* If XALLOC_FAIL_FUNC is NULL, or does return, display this message
5ec174d20066 Add comments.
Jim Meyering <jim@meyering.net>
parents: 1557
diff changeset
61 before exiting when memory is exhausted. Goes through gettext. */
2814
bae17cdae026 (xalloc_msg_memory_exhausted): Now char const[],
Jim Meyering <jim@meyering.net>
parents: 2793
diff changeset
62 char const xalloc_msg_memory_exhausted[] = N_("memory exhausted");
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
63
1956
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
64 void
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
65 xalloc_die (void)
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
66 {
1088
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
67 if (xalloc_fail_func)
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
68 (*xalloc_fail_func) ();
4473
fd6696a97000 Sync with coreutils xalloc.h, xmalloc.c, xmemcoll.h, xmemcoll.c.
Paul Eggert <eggert@cs.ucla.edu>
parents: 4397
diff changeset
69 error (exit_failure, 0, "%s", _(xalloc_msg_memory_exhausted));
1956
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
70 /* The `noreturn' cannot be given to error, since it may return if
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
71 its first argument is 0. To help compilers understand the
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
72 xalloc_die does terminate, call exit. */
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
73 exit (EXIT_FAILURE);
399
c41f22e4dae3 sync from FSF
Jim Meyering <jim@meyering.net>
parents: 9
diff changeset
74 }
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
75
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
76 /* Allocate N bytes of memory dynamically, with error checking. */
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
77
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
78 void *
1557
38fd8f5d359d ansideclify
Jim Meyering <jim@meyering.net>
parents: 1120
diff changeset
79 xmalloc (size_t n)
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
80 {
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
81 void *p;
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
82
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
83 p = malloc (n);
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
84 if (p == 0)
1956
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
85 xalloc_die ();
9
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
86 return p;
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
87 }
f8dce34b5ab0 Initial revision
Jim Meyering <jim@meyering.net>
parents:
diff changeset
88
1088
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
89 /* Change the size of an allocated block of memory P to N bytes,
2814
bae17cdae026 (xalloc_msg_memory_exhausted): Now char const[],
Jim Meyering <jim@meyering.net>
parents: 2793
diff changeset
90 with error checking. */
1088
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
91
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
92 void *
1557
38fd8f5d359d ansideclify
Jim Meyering <jim@meyering.net>
parents: 1120
diff changeset
93 xrealloc (void *p, size_t n)
1088
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
94 {
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
95 p = realloc (p, n);
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
96 if (p == 0)
1956
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
97 xalloc_die ();
1088
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
98 return p;
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
99 }
1ae95221563d (xalloc_fail): Renamed from fixup_null_alloc.
Jim Meyering <jim@meyering.net>
parents: 1080
diff changeset
100
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
101 /* Allocate memory for N elements of S bytes, with error checking. */
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
102
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
103 void *
1557
38fd8f5d359d ansideclify
Jim Meyering <jim@meyering.net>
parents: 1120
diff changeset
104 xcalloc (size_t n, size_t s)
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
105 {
1071
dba5761efd8d Include xalloc.h.
Jim Meyering <jim@meyering.net>
parents: 739
diff changeset
106 void *p;
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
107
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
108 p = calloc (n, s);
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
109 if (p == 0)
1956
b04912653d02 (xalloc_die): Rename from xalloc_fail and update callers.
Jim Meyering <jim@meyering.net>
parents: 1940
diff changeset
110 xalloc_die ();
739
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
111 return p;
14a5ef1999ae libitize
Jim Meyering <jim@meyering.net>
parents: 653
diff changeset
112 }