annotate lib/eealloc.h @ 10074:cf0a8e173c39

Help GCC to do better code generation.
author Bruno Haible <bruno@clisp.org>
date Thu, 15 May 2008 02:01:46 +0200
parents bbbbbf4cd1c5
children b5e42ef33b49
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.
10074
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
2 Copyright (C) 2003, 2008 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
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
17 along with this program. If not, see <http://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
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
34 #if MALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
35 # define eemalloc malloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
36 #else
10074
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
37 # if __GNUC__ >= 3
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
38 static inline void *eemalloc (size_t n) __attribute__ ((__malloc__));
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
39 # endif
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 static inline void *
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 eemalloc (size_t n)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
42 {
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
43 /* If n is zero, allocate a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
44 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
45 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
46 return malloc (n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
47 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
48 #endif
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
49
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
50 #if REALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 # define eerealloc realloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 #else
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 static inline void *
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 eerealloc (void *p, size_t n)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 {
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 /* If n is zero, allocate or keep a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59 return realloc (p, n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 #endif
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
63 /* Maybe we should also define variants
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
64 eenmalloc (size_t n, size_t s) - behaves like eemalloc (n * s)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
65 eezalloc (size_t n) - like eemalloc followed by memset 0
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
66 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
67 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
68 If this would be useful in your application. please speak up. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
69
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
70 #endif /* _EEALLOC_H */