Mercurial > hg > octave-kai > gnulib-hg

annotate lib/allocator.h @ 16201:8250f2777afc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: update all copyright year number ranges Run "make update-copyright".
author Jim Meyering <meyering@redhat.com>
date Sun, 01 Jan 2012 10:04:58 +0100
parents f5ea64b67bec
children e542fd46ad6f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
1 /* Memory allocators such as malloc+free.
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2
16201
8250f2777afc maint: update all copyright year number ranges
Jim Meyering <meyering@redhat.com>
parents: 14854
diff changeset
3 Copyright (C) 2011-2012 Free Software Foundation, Inc.
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
5 This program is free software: you can redistribute it and/or modify
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 it under the terms of the GNU General Public License as published by
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
7 the Free Software Foundation; either version 3 of the License, or
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
8 (at your option) any later version.
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10 This program is distributed in the hope that it will be useful,
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 GNU General Public License for more details.
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15 You should have received a copy of the GNU General Public License
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18 /* Written by Paul Eggert. */
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20 #ifndef _GL_ALLOCATOR_H
14555
68b42f132c0c allocator, careadlinkat: Fix double-inclusion guard.
Bruno Haible <bruno@clisp.org>
parents: 14549
diff changeset
21 #define _GL_ALLOCATOR_H
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
23 #include <stddef.h>
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
25 /* An object describing a memory allocator family. */
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
26
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27 struct allocator
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28 {
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
29 /* Do not use GCC attributes such as __attribute__ ((malloc)) with
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30 the function types pointed at by these members, because these
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31 attributes do not work with pointers to functions. See
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32 <http://lists.gnu.org/archive/html/bug-gnulib/2011-04/msg00007.html>. */
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33
14537
10946c7debf8 careadlinkat: rename members to avoid problem
Paul Eggert <eggert@cs.ucla.edu>
parents: 14522
diff changeset
34 /* Call ALLOCATE to allocate memory, like 'malloc'. On failure ALLOCATE
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
35 should return NULL, though not necessarily set errno. When given
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
36 a zero size it may return NULL even if successful. */
14537
10946c7debf8 careadlinkat: rename members to avoid problem
Paul Eggert <eggert@cs.ucla.edu>
parents: 14522
diff changeset
37 void *(*allocate) (size_t);
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
38
14537
10946c7debf8 careadlinkat: rename members to avoid problem
Paul Eggert <eggert@cs.ucla.edu>
parents: 14522
diff changeset
39 /* If nonnull, call REALLOCATE to reallocate memory, like 'realloc'.
10946c7debf8 careadlinkat: rename members to avoid problem
Paul Eggert <eggert@cs.ucla.edu>
parents: 14522
diff changeset
40 On failure REALLOCATE should return NULL, though not necessarily set
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
41 errno. When given a zero size it may return NULL even if
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
42 successful. */
14537
10946c7debf8 careadlinkat: rename members to avoid problem
Paul Eggert <eggert@cs.ucla.edu>
parents: 14522
diff changeset
43 void *(*reallocate) (void *, size_t);
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
44
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 /* Call FREE to free memory, like 'free'. */
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
46 void (*free) (void *);
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47
14854
f5ea64b67bec allocator: 'die' routine is now given requested size
Paul Eggert <eggert@cs.ucla.edu>
parents: 14555
diff changeset
48 /* If nonnull, call DIE (SIZE) if MALLOC (SIZE) or REALLOC (...,
f5ea64b67bec allocator: 'die' routine is now given requested size
Paul Eggert <eggert@cs.ucla.edu>
parents: 14555
diff changeset
49 SIZE) fails. DIE should not return. SIZE should equal SIZE_MAX
f5ea64b67bec allocator: 'die' routine is now given requested size
Paul Eggert <eggert@cs.ucla.edu>
parents: 14555
diff changeset
50 if size_t overflow was detected while calculating sizes to be
f5ea64b67bec allocator: 'die' routine is now given requested size
Paul Eggert <eggert@cs.ucla.edu>
parents: 14555
diff changeset
51 passed to MALLOC or REALLOC. */
f5ea64b67bec allocator: 'die' routine is now given requested size
Paul Eggert <eggert@cs.ucla.edu>
parents: 14555
diff changeset
52 void (*die) (size_t);
14522
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
53 };
39a9dbe4bfe3 areadlink, areadlinkat: rewrite in terms of careadlinkat
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54
14549
f87295656694 allocator: New module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 14537
diff changeset
55 /* An allocator using the stdlib functions and a null DIE function. */
f87295656694 allocator: New module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 14537
diff changeset
56 extern struct allocator const stdlib_allocator;
f87295656694 allocator: New module.
Paul Eggert <eggert@cs.ucla.edu>
parents: 14537
diff changeset
57
14555
68b42f132c0c allocator, careadlinkat: Fix double-inclusion guard.
Bruno Haible <bruno@clisp.org>
parents: 14549
diff changeset
58 #endif /* _GL_ALLOCATOR_H */