annotate lib/eealloc.h @ 17102:9e72d3927af1

binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline' * lib/binary-io.c, lib/eealloc.c, lib/mbfile.c, lib/mbiter.c: * lib/mbuiter.c, lib/xsize.c: New files. * lib/binary-io.h (BINARY_IO_INLINE): * lib/eealloc.h (EEALLOC_INLINE): * lib/mbfile.h (MBFILE_INLINE): * lib/mbiter.h (MBITER_INLINE): * lib/mbuiter.h (MBUITER_INLINE): * lib/xsize.h (XSIZE_INLINE): New macros. Replace all uses of 'static inline' with them. Use _GL_INLINE_HEADER_BEGIN, _GL_INLINE_HEADER_END. * m4/eealloc.m4 (gl_EEALLOC): * m4/mbfile.m4 (gl_MBFILE): * m4/mbiter.m4 (gl_MBITER): * m4/xsize.m4 (gl_XSIZE): Do not require AC_C_INLINE. * modules/binary-io (Files, lib_SOURCES): Add lib/binary-io.c * modules/eealloc (Files, lib_SOURCES): Add lib/eealloc.c. * modules/mbfile (Files, lib_SOURCES): Add lib/mbfile.c. * modules/mbiter (Files, lib_SOURCES): Add lib/mbiter.c. * modules/mbuiter (Files, lib_SOURCES): Add lib/mbuiter.c. * modules/xsize (Files, lib_SOURCES): Add lib/xsize.c. * modules/binary-io, modules/eealloc, modules/mbfile: * modules/mbiter, modules/mbuiter: (Depends-on): Add extern-inline.
author Paul Eggert <eggert@cs.ucla.edu>
date Wed, 29 Aug 2012 23:13:42 -0700
parents 8250f2777afc
children e542fd46ad6f
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.
16201
8250f2777afc maint: update all copyright year number ranges
Jim Meyering <meyering@redhat.com>
parents: 14079
diff changeset
2 Copyright (C) 2003, 2008, 2010-2012 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
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
34 _GL_INLINE_HEADER_BEGIN
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
35 #ifndef EEALLOC_INLINE
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
36 # 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
37 #endif
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
38
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
39 #if MALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
40 # define eemalloc malloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
41 #else
10074
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
42 # if __GNUC__ >= 3
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
43 EEALLOC_INLINE void *eemalloc (size_t n)
13815
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
44 __attribute__ ((__malloc__))
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
45 # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
46 __attribute__ ((__alloc_size__ (1)))
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
47 # endif
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
48 ;
10074
cf0a8e173c39 Help GCC to do better code generation.
Bruno Haible <bruno@clisp.org>
parents: 9309
diff changeset
49 # endif
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
50 EEALLOC_INLINE void *
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
51 eemalloc (size_t n)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
52 {
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
53 /* If n is zero, allocate a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
54 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
55 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
56 return malloc (n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
57 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
58 #endif
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
59
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
60 #if REALLOC_0_IS_NONNULL
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
61 # define eerealloc realloc
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
62 #else
13815
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
63 # if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
64 EEALLOC_INLINE void *eerealloc (void *p, size_t n)
13815
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
65 __attribute__ ((__alloc_size__ (2)));
86abc8c3b7d9 Make use of GCC's attribute __alloc_size__.
Bruno Haible <bruno@clisp.org>
parents: 12559
diff changeset
66 # endif
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 *
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
68 eerealloc (void *p, size_t n)
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 /* If n is zero, allocate or keep a 1-byte block. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
71 if (n == 0)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
72 n = 1;
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
73 return realloc (p, n);
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
74 }
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
75 #endif
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 /* Maybe we should also define variants
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
78 eenmalloc (size_t n, size_t s) - behaves like eemalloc (n * s)
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
79 eezalloc (size_t n) - like eemalloc followed by memset 0
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
80 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
81 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
82 If this would be useful in your application. please speak up. */
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
83
17102
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
84 _GL_INLINE_HEADER_END
9e72d3927af1 binary-io, eealloc, mbfile, mbiter, mbutil, xsize: better 'inline'
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
85
4919
759a578edd98 New module 'eealloc'.
Bruno Haible <bruno@clisp.org>
parents:
diff changeset
86 #endif /* _EEALLOC_H */