annotate lib/eealloc.h @ 40057:b06060465f09

maint: Run 'make update-copyright'
author Paul Eggert <eggert@cs.ucla.edu>
date Tue, 01 Jan 2019 00:25:11 +0100
parents 0b05f2be9830
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
1 /* Memory allocation with expensive empty allocations.
40057
b06060465f09 maint: Run 'make update-copyright'
Paul Eggert <eggert@cs.ucla.edu>
parents: 19596
diff changeset
2 Copyright (C) 2003, 2008, 2010-2019 Free Software Foundation, Inc.
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
3 Written by Bruno Haible <bruno@clisp.org>, 2003,
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
4 based on prior work by Jim Meyering.
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
5
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
6 This program is free software: you can redistribute it and/or modify
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
8 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
9 (at your option) any later version.
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
10
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
14 GNU General Public License for more details.
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
15
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
19190
9759915b2aca all: prefer https: URLs
Paul Eggert <eggert@cs.ucla.edu>
parents: 18626
diff changeset
17 along with this program. If not, see <https://www.gnu.org/licenses/>. */
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
18
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
19 #ifndef _EEALLOC_H
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
20 #define _EEALLOC_H
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
21
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
22 /* malloc() and realloc() are allowed to return NULL when asked to allocate
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
23 a memory block of 0 bytes; this is not an out-of-memory condition.
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
24 (See ISO C 99 section 7.20.3.) In some places, this is not welcome,
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
25 because it requires extra checking (so as not to confuse a zero-sized
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
26 allocation with an out-of-memory condition). This file provides
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
27 malloc()/realloc() workalikes which return non-NULL pointers for
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
28 succeeding zero-sized allocations. GNU libc already defines malloc()
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
29 and realloc() this way; on such platforms the workalikes are aliased
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
30 to the original malloc()/realloc() functions. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
31
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
32 #include <stdlib.h>
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
33
17473
1f9070ef79b0 headers: check that _GL_INLINE_HEADER_BEGIN is defined
Paul Eggert <eggert@cs.ucla.edu>
parents: 17249
diff changeset
34 #ifndef _GL_INLINE_HEADER_BEGIN
1f9070ef79b0 headers: check that _GL_INLINE_HEADER_BEGIN is defined
Paul Eggert <eggert@cs.ucla.edu>
parents: 17249
diff changeset
35 #error "Please include config.h first."
1f9070ef79b0 headers: check that _GL_INLINE_HEADER_BEGIN is defined
Paul Eggert <eggert@cs.ucla.edu>
parents: 17249
diff changeset
36 #endif
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
37 _GL_INLINE_HEADER_BEGIN
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
38 #ifndef EEALLOC_INLINE
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
39 # define EEALLOC_INLINE _GL_INLINE
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
40 #endif
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
41
17976
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
42 #if ! defined __clang__ && \
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
43 (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3))
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
44 # define _GL_ATTRIBUTE_ALLOC_SIZE(args) __attribute__ ((__alloc_size__ args))
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
45 #else
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
46 # define _GL_ATTRIBUTE_ALLOC_SIZE(args)
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
47 #endif
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
48
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49 #if MALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50 # define eemalloc malloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 #else
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
52 EEALLOC_INLINE void *eemalloc (size_t n)
17976
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
53 _GL_ATTRIBUTE_MALLOC _GL_ATTRIBUTE_ALLOC_SIZE ((1));
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
54 EEALLOC_INLINE void *
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 eemalloc (size_t n)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 {
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 /* If n is zero, allocate a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 return malloc (n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 #endif
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 #if REALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 # define eerealloc realloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 #else
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
67 EEALLOC_INLINE void *eerealloc (void *p, size_t n)
17976
64dd75ab6054 eealloc, pagealign_alloc, xalloc: avoid clang warnings
Pádraig Brady <P@draigBrady.com>
parents: 17848
diff changeset
68 _GL_ATTRIBUTE_ALLOC_SIZE ((2));
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
69 EEALLOC_INLINE void *
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 eerealloc (void *p, size_t n)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 {
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 /* If n is zero, allocate or keep a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 return realloc (p, n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
76 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
77 #endif
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 /* Maybe we should also define variants
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 eenmalloc (size_t n, size_t s) - behaves like eemalloc (n * s)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
81 eezalloc (size_t n) - like eemalloc followed by memset 0
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
82 eecalloc (size_t n, size_t s) - like eemalloc (n * s) followed by memset 0
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83 eenrealloc (void *p, size_t n, size_t s) - like eerealloc (p, n * s)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
84 If this would be useful in your application. please speak up. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
85
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
86 _GL_INLINE_HEADER_END
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
87
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
88 #endif /* _EEALLOC_H */