publish
[alioth/cvs.git] / lib / pagealign_alloc.c
1 /* Memory allocation aligned to system page boundaries.
2
3    Copyright (C) 2005 Free Software Foundation, Inc.
4
5    This program is free software; you can redistribute it and/or modify it
6    under the terms of the GNU General Public License as published
7    by the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    General Public License for more details.
14
15    You should have received a copy of the GNU General Public
16    License along with this program; if not, write to the Free Software
17    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
18    USA.  */
19
20 /* Written by Derek R. Price <derek@ximbiot.com>.  */
21
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 #include "pagealign_alloc.h"
27
28 #include <errno.h>
29 #include <stdlib.h>
30
31 #include <fcntl.h>
32
33 #if HAVE_UNISTD_H
34 # include <unistd.h>
35 #endif
36
37 #if HAVE_MMAP
38 # include <sys/mman.h>
39 #endif
40
41 #include "error.h"
42 #include "exit.h"
43 #include "getpagesize.h"
44 #include "xalloc.h"
45 #include "gettext.h"
46
47 #if HAVE_MMAP && !defined(HAVE_MAP_ANONYMOUS)
48 #include <stdio.h>
49 #endif
50
51 #define _(str) gettext (str)
52
53 #if HAVE_MMAP
54 /* Define MAP_FILE when it isn't otherwise.  */
55 # ifndef MAP_FILE
56 #  define MAP_FILE 0
57 # endif
58 /* Define MAP_FAILED for old systems which neglect to.  */
59 # ifndef MAP_FAILED
60 #  define MAP_FAILED ((void *)-1)
61 # endif
62 #endif
63
64
65 #if HAVE_MMAP || ! HAVE_POSIX_MEMALIGN
66
67 # if HAVE_MMAP
68 /* For each memory region, we store its size.  */
69 typedef size_t info_t;
70 # else
71 /* For each memory region, we store the original pointer returned by
72    malloc().  */
73 typedef void * info_t;
74 # endif
75
76 /* A simple linked list of allocated memory regions.  It is probably not the
77    most efficient way to store these, but anyway...  */
78 typedef struct memnode_s memnode_t;
79 struct memnode_s
80 {
81   void *aligned_ptr;
82   info_t info;
83   memnode_t *next;
84 };
85
86 /* The list of currently allocated memory regions.  */
87 static memnode_t *memnode_table = NULL;
88
89
90 static void
91 new_memnode (void *aligned_ptr, info_t info)
92 {
93   memnode_t *new_node = (memnode_t *) xmalloc (sizeof (memnode_t));
94   new_node->aligned_ptr = aligned_ptr;
95   new_node->info = info;
96   new_node->next = memnode_table;
97   memnode_table = new_node;
98 }
99
100
101 /* Dispose of the memnode containing a map for the ALIGNED_PTR in question
102    and return the content of the node's INFO field.  */
103 static info_t
104 get_memnode (void *aligned_ptr)
105 {
106   info_t ret;
107   memnode_t *c;
108   memnode_t **p_next = &memnode_table;
109
110   for (c = *p_next; c != NULL; p_next = &c->next, c = c->next)
111     if (c->aligned_ptr == aligned_ptr)
112       break;
113
114   if (c == NULL)
115     /* An attempt to free untracked memory.  A wrong pointer was passed
116        to pagealign_free().  */
117     abort ();
118
119   /* Remove this entry from the list, save the return value, and free it.  */
120   *p_next = c->next;
121   ret = c->info;
122   free (c);
123
124   return ret;
125 }
126
127 #endif /* HAVE_MMAP || !HAVE_POSIX_MEMALIGN */
128
129
130 void *
131 pagealign_alloc (size_t size)
132 {
133   void *ret;
134 #if HAVE_MMAP
135 # ifdef HAVE_MAP_ANONYMOUS
136   const int fd = -1;
137   const int flags = MAP_ANONYMOUS | MAP_PRIVATE;
138 # else /* !HAVE_MAP_ANONYMOUS */
139   static int beenhere = 0;
140   static int fd = -1;  /* Only open /dev/zero once in order to avoid limiting
141                           the amount of memory we may allocate based on the
142                           number of open file descriptors.  */
143   const int flags = MAP_FILE | MAP_PRIVATE;
144   if (fd == -1)
145     {
146       fd = open ("/dev/zero", O_RDONLY, 0666);
147       if (fd < 0)
148         {
149           if (!beenhere)
150             {
151               beenhere = 1;
152               error (EXIT_FAILURE, errno, _("Failed to open /dev/zero for read"));
153             }
154           else
155             {
156               fprintf (stderr, "Fatal in pagealign: %s\n",
157                         _("Failed to open /dev/zero for read"));
158               fflush (stderr);
159               _exit (EXIT_FAILURE);
160             }
161         }
162     }
163 # endif /* HAVE_MAP_ANONYMOUS */
164   ret = mmap (NULL, size, PROT_READ | PROT_WRITE, flags, fd, 0);
165   if (ret == MAP_FAILED)
166     return NULL;
167   new_memnode (ret, size);
168 #elif HAVE_POSIX_MEMALIGN
169   int status = posix_memalign (&ret, getpagesize (), size);
170   if (status)
171     {
172       errno = status;
173       return NULL;
174     }
175 #else /* !HAVE_MMAP && !HAVE_POSIX_MEMALIGN */
176   size_t pagesize = getpagesize ();
177   void *unaligned_ptr = malloc (size + pagesize - 1);
178   if (unaligned_ptr == NULL)
179     {
180       /* Set errno.  We don't know whether malloc already set errno: some
181          implementations of malloc do, some don't.  */
182       errno = ENOMEM;
183       return NULL;
184     }
185   ret = (char *) unaligned_ptr
186         + ((- (unsigned long) unaligned_ptr) & (pagesize - 1));
187   new_memnode (ret, unaligned_ptr);
188 #endif /* HAVE_MMAP && HAVE_POSIX_MEMALIGN */
189   return ret;
190 }
191
192
193 void *
194 pagealign_xalloc (size_t size)
195 {
196   void *ret;
197
198   ret = pagealign_alloc (size);
199   if (ret == NULL)
200     xalloc_die ();
201   return ret;
202 }
203
204
205 void
206 pagealign_free (void *aligned_ptr)
207 {
208 #if HAVE_MMAP
209   if (munmap (aligned_ptr, get_memnode (aligned_ptr)) < 0)
210     error (EXIT_FAILURE, errno, "Failed to unmap memory");
211 #elif HAVE_POSIX_MEMALIGN
212   free (aligned_ptr);
213 #else
214   free (get_memnode (aligned_ptr));
215 #endif
216 }