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 #if HAVE_FCNTL_H
  32 # include <fcntl.h>
  33 #endif
  34
  35 #if HAVE_UNISTD_H
  36 # include <unistd.h>
  37 #endif
  38
  39 #if HAVE_MMAP
  40 # include <sys/mman.h>
  41 #endif
  42
  43 #include "error.h"
  44 #include "exit.h"
  45 #include "getpagesize.h"
  46 #include "xalloc.h"
  47 #include "gettext.h"
  48
  49 #define _(str) gettext (str)
  50
  51 #if HAVE_MMAP
  52 /* Define MAP_FILE when it isn't otherwise.  */
  53 # ifndef MAP_FILE
  54 #  define MAP_FILE 0
  55 # endif
  56 /* Define MAP_FAILED for old systems which neglect to.  */
  57 # ifndef MAP_FAILED
  58 #  define MAP_FAILED ((void *)-1)
  59 # endif
  60 #endif
  61
  62
  63 #if HAVE_MMAP || ! HAVE_POSIX_MEMALIGN
  64
  65 # if HAVE_MMAP
  66 /* For each memory region, we store its size.  */
  67 typedef size_t info_t;
  68 # else
  69 /* For each memory region, we store the original pointer returned by
  70    malloc().  */
  71 typedef void * info_t;
  72 # endif
  73
  74 /* A simple linked list of allocated memory regions.  It is probably not the
  75    most efficient way to store these, but anyway...  */
  76 typedef struct memnode_s memnode_t;
  77 struct memnode_s
  78 {
  79   void *aligned_ptr;
  80   info_t info;
  81   memnode_t *next;
  82 };
  83
  84 /* The list of currently allocated memory regions.  */
  85 static memnode_t *memnode_table = NULL;
  86
  87
  88 static void
  89 new_memnode (void *aligned_ptr, info_t info)
  90 {
  91   memnode_t *new_node = (memnode_t *) xmalloc (sizeof (memnode_t));
  92   new_node->aligned_ptr = aligned_ptr;
  93   new_node->info = info;
  94   new_node->next = memnode_table;
  95   memnode_table = new_node;
  96 }
  97
  98
  99 /* Dispose of the memnode containing a map for the ALIGNED_PTR in question
 100    and return the content of the node's INFO field.  */
 101 static info_t
 102 get_memnode (void *aligned_ptr)
 103 {
 104   info_t ret;
 105   memnode_t *c;
 106   memnode_t **p_next = &memnode_table;
 107
 108   for (c = *p_next; c != NULL; p_next = &c->next, c = c->next)
 109     if (c->aligned_ptr == aligned_ptr)
 110       break;
 111
 112   if (c == NULL)
 113     /* An attempt to free untracked memory.  A wrong pointer was passed
 114        to pagealign_free().  */
 115     abort ();
 116
 117   /* Remove this entry from the list, save the return value, and free it.  */
 118   *p_next = c->next;
 119   ret = c->info;
 120   free (c);
 121
 122   return ret;
 123 }
 124
 125 #endif /* HAVE_MMAP || !HAVE_POSIX_MEMALIGN */
 126
 127
 128 void *
 129 pagealign_alloc (size_t size)
 130 {
 131   void *ret;
 132 #if HAVE_MMAP
 133 # ifdef HAVE_MAP_ANONYMOUS
 134   const int fd = -1;
 135   const int flags = MAP_ANONYMOUS | MAP_PRIVATE;
 136 # else /* !HAVE_MAP_ANONYMOUS */
 137   static int fd = -1;  /* Only open /dev/zero once in order to avoid limiting
 138                           the amount of memory we may allocate based on the
 139                           number of open file descriptors.  */
 140   const int flags = MAP_FILE | MAP_PRIVATE;
 141   if (fd == -1)
 142     {
 143       fd = open ("/dev/zero", O_RDONLY, 0666);
 144       if (fd < 0)
 145         error (EXIT_FAILURE, errno, _("Failed to open /dev/zero for read"));
 146     }
 147 # endif /* HAVE_MAP_ANONYMOUS */
 148   ret = mmap (NULL, size, PROT_READ | PROT_WRITE, flags, fd, 0);
 149   if (ret == MAP_FAILED)
 150     return NULL;
 151   new_memnode (ret, size);
 152 #elif HAVE_POSIX_MEMALIGN
 153   int status = posix_memalign (&ret, getpagesize (), size);
 154   if (status)
 155     {
 156       errno = status;
 157       return NULL;
 158     }
 159 #else /* !HAVE_MMAP && !HAVE_POSIX_MEMALIGN */
 160   size_t pagesize = getpagesize ();
 161   void *unaligned_ptr = malloc (size + pagesize - 1);
 162   if (unaligned_ptr == NULL)
 163     {
 164       /* Set errno.  We don't know whether malloc already set errno: some
 165          implementations of malloc do, some don't.  */
 166       errno = ENOMEM;
 167       return NULL;
 168     }
 169   ret = (char *) unaligned_ptr
 170         + ((- (unsigned long) unaligned_ptr) & (pagesize - 1));
 171   new_memnode (ret, unaligned_ptr);
 172 #endif /* HAVE_MMAP && HAVE_POSIX_MEMALIGN */
 173   return ret;
 174 }
 175
 176
 177 void *
 178 pagealign_xalloc (size_t size)
 179 {
 180   void *ret;
 181
 182   ret = pagealign_alloc (size);
 183   if (ret == NULL)
 184     xalloc_die ();
 185   return ret;
 186 }
 187
 188
 189 void
 190 pagealign_free (void *aligned_ptr)
 191 {
 192 #if HAVE_MMAP
 193   if (munmap (aligned_ptr, get_memnode (aligned_ptr)) < 0)
 194     error (EXIT_FAILURE, errno, "Failed to unmap memory");
 195 #elif HAVE_POSIX_MEMALIGN
 196   free (aligned_ptr);
 197 #else
 198   free (get_memnode (aligned_ptr));
 199 #endif
 200 }