src/xbt/mmalloc/mmap-sup.c

   1 /* Support for an sbrk-like function that uses mmap.
   2    Copyright 1992, 2000 Free Software Foundation, Inc.
   3
   4    Contributed by Fred Fish at Cygnus Support.   fnf@cygnus.com */
   5
   6 /* Copyright (c) 2010. The SimGrid Team.
   7  * All rights reserved.                                                     */
   8
   9 /* This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the license (GNU LGPL) which comes with this package. */
  11
  12 #ifndef MAP_ANONYMOUS
  13 #define MAP_ANONYMOUS MAP_ANON
  14 #endif
  15
  16 #ifdef HAVE_UNISTD_H
  17 #include <unistd.h>             /* Prototypes for lseek */
  18 #endif
  19 #include <stdio.h>
  20 #include <fcntl.h>
  21 #include <sys/mman.h>
  22
  23 #ifndef SEEK_SET
  24 #define SEEK_SET 0
  25 #endif
  26
  27 #include "mmprivate.h"
  28
  29 /* Cache the pagesize for the current host machine.  Note that if the host
  30    does not readily provide a getpagesize() function, we need to emulate it
  31    elsewhere, not clutter up this file with lots of kluges to try to figure
  32    it out. */
  33
  34 static size_t pagesize;
  35 #if NEED_DECLARATION_GETPAGESIZE
  36 extern int getpagesize(void);
  37 #endif
  38
  39 #define PAGE_ALIGN(addr) (void*) (((long)(addr) + pagesize - 1) & \
  40                                     ~(pagesize - 1))
  41
  42 /* Return MAP_PRIVATE if MDP represents /dev/zero.  Otherwise, return
  43    MAP_SHARED.  */
  44
  45 #define MAP_PRIVATE_OR_SHARED(MDP) (( MDP -> flags & MMALLOC_ANONYMOUS) \
  46                                     ? MAP_PRIVATE \
  47                                     : MAP_SHARED)
  48
  49 /* Return MAP_ANONYMOUS if MDP uses anonymous mapping. Otherwise, return 0 */
  50
  51 #define MAP_IS_ANONYMOUS(MDP) (((MDP) -> flags & MMALLOC_ANONYMOUS) \
  52                               ? MAP_ANONYMOUS \
  53                               : 0)
  54
  55 /* Return -1 if MDP uses anonymous mapping. Otherwise, return MDP->FD */
  56 #define MAP_ANON_OR_FD(MDP) (((MDP) -> flags & MMALLOC_ANONYMOUS) \
  57                               ? -1 \
  58                                               : (MDP) -> fd)
  59
  60 /*  Get core for the memory region specified by MDP, using SIZE as the
  61     amount to either add to or subtract from the existing region.  Works
  62     like sbrk(), but using mmap(). */
  63
  64 void *__mmalloc_mmap_morecore(struct mdesc *mdp, int size)
  65 {
  66   ssize_t test = 0;
  67   void *result = NULL;
  68   off_t foffset;                /* File offset at which new mapping will start */
  69   size_t mapbytes;              /* Number of bytes to map */
  70   void *moveto;                 /* Address where we wish to move "break value" to */
  71   void *mapto;                  /* Address we actually mapped to */
  72   char buf = 0;                 /* Single byte to write to extend mapped file */
  73
  74   if (pagesize == 0)
  75     pagesize = getpagesize();
  76
  77   if (size == 0) {
  78     /* Just return the current "break" value. */
  79     result = mdp->breakval;
  80   } else if (size < 0) {
  81     /* We are deallocating memory.  If the amount requested would cause
  82        us to try to deallocate back past the base of the mmap'd region
  83        then do nothing, and return NULL.  Otherwise, deallocate the
  84        memory and return the old break value. */
  85     if (((char *) mdp->breakval) + size >= (char *) mdp->base) {
  86       result = (void *) mdp->breakval;
  87       mdp->breakval = (char *) mdp->breakval + size;
  88       moveto = PAGE_ALIGN(mdp->breakval);
  89       munmap(moveto,
  90              (size_t) (((char *) mdp->top) - ((char *) moveto)) - 1);
  91       mdp->top = moveto;
  92     }
  93   } else {
  94     /* We are allocating memory. Make sure we have an open file
  95        descriptor if not working with anonymous memory. */
  96     if (!(mdp->flags & MMALLOC_ANONYMOUS) && mdp->fd < 0) {
  97       result = NULL;
  98     } else if ((char *) mdp->breakval + size > (char *) mdp->top) {
  99       /* The request would move us past the end of the currently
 100          mapped memory, so map in enough more memory to satisfy
 101          the request.  This means we also have to grow the mapped-to
 102          file by an appropriate amount, since mmap cannot be used
 103          to extend a file. */
 104       moveto = PAGE_ALIGN((char *) mdp->breakval + size);
 105       mapbytes = (char *) moveto - (char *) mdp->top;
 106       foffset = (char *) mdp->top - (char *) mdp->base;
 107
 108       if (mdp->fd > 0) {
 109         /* FIXME:  Test results of lseek() and write() */
 110         lseek(mdp->fd, foffset + mapbytes - 1, SEEK_SET);
 111         test = write(mdp->fd, &buf, 1);
 112       }
 113
 114       /* Let's call mmap. Note that it is possible that mdp->top
 115          is 0. In this case mmap will choose the address for us */
 116       mapto = mmap(mdp->top, mapbytes, PROT_READ | PROT_WRITE,
 117                    MAP_PRIVATE_OR_SHARED(mdp) | MAP_IS_ANONYMOUS(mdp) |
 118                    MAP_FIXED, MAP_ANON_OR_FD(mdp), foffset);
 119
 120       if (mapto != (void *) -1) {
 121
 122         if (mdp->top == 0)
 123           mdp->base = mdp->breakval = mapto;
 124
 125         mdp->top = PAGE_ALIGN((char *) mdp->breakval + size);
 126         result = (void *) mdp->breakval;
 127         mdp->breakval = (char *) mdp->breakval + size;
 128       }
 129     } else {
 130       result = (void *) mdp->breakval;
 131       mdp->breakval = (char *) mdp->breakval + size;
 132     }
 133   }
 134   return (result);
 135 }
 136
 137 void *__mmalloc_remap_core(struct mdesc *mdp)
 138 {
 139   void *base;
 140
 141   /* FIXME:  Quick hack, needs error checking and other attention. */
 142
 143   base = mmap(mdp->base, (char *) mdp->top - (char *) mdp->base,
 144               PROT_READ | PROT_WRITE | PROT_EXEC,
 145               MAP_PRIVATE_OR_SHARED(mdp) | MAP_FIXED, mdp->fd, 0);
 146   return ((void *) base);
 147 }
 148
 149 void *mmalloc_findbase(int size)
 150 {
 151   int fd;
 152   int flags;
 153   void *base = NULL;
 154
 155 #ifdef MAP_ANONYMOUS
 156   flags = MAP_PRIVATE | MAP_ANONYMOUS;
 157   fd = -1;
 158 #else
 159 #ifdef MAP_FILE
 160   flags = MAP_PRIVATE | MAP_FILE;
 161 #else
 162   flags = MAP_PRIVATE;
 163 #endif
 164   fd = open("/dev/zero", O_RDWR);
 165   if (fd != -1) {
 166     return ((void *) NULL);
 167   }
 168 #endif
 169   base = mmap(0, size, PROT_READ | PROT_WRITE, flags, fd, 0);
 170   if (base != (void *) -1) {
 171     munmap(base, (size_t) size);
 172   }
 173   if (fd != -1) {
 174     close(fd);
 175   }
 176   if (base == 0) {
 177     /* Don't allow mapping at address zero.  We use that value
 178        to signal an error return, and besides, it is useful to
 179        catch NULL pointers if it is unmapped.  Instead start
 180        at the next page boundary. */
 181     base = (void *) (long) getpagesize();
 182   } else if (base == (void *) -1) {
 183     base = NULL;
 184   }
 185   return ((void *) base);
 186 }