src/xbt/mmalloc/mmorecore.c

   1 /* Support for an sbrk-like function that uses mmap. */
   2
   3 /* Copyright (c) 2010-2014. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 /* Copyright 1992, 2000 Free Software Foundation, Inc.
  10
  11    Contributed by Fred Fish at Cygnus Support.   fnf@cygnus.com */
  12
  13 #include "src/internal_config.h"
  14 #if HAVE_UNISTD_H
  15 #include <unistd.h>             /* Prototypes for lseek */
  16 #endif
  17 #include <stdio.h>
  18 #include <fcntl.h>
  19 #include <sys/mman.h>
  20 #include <sys/wait.h>
  21 #include <errno.h>
  22
  23 #include "mmprivate.h"
  24
  25 #ifndef MAP_ANONYMOUS
  26 #define MAP_ANONYMOUS MAP_ANON
  27 #endif
  28
  29 #define PAGE_ALIGN(addr) (void*) (((long)(addr) + xbt_pagesize - 1) &   \
  30                                   ~((long)xbt_pagesize - 1))
  31
  32 /* Return MAP_PRIVATE if MDP represents /dev/zero.  Otherwise, return
  33    MAP_SHARED.  */
  34 #define MAP_PRIVATE_OR_SHARED(MDP) (( MDP -> flags & MMALLOC_ANONYMOUS) \
  35                                     ? MAP_PRIVATE                       \
  36                                     : MAP_SHARED)
  37
  38 /* Return MAP_ANONYMOUS if MDP uses anonymous mapping. Otherwise, return 0 */
  39 #define MAP_IS_ANONYMOUS(MDP) (((MDP) -> flags & MMALLOC_ANONYMOUS) \
  40                                ? MAP_ANONYMOUS                      \
  41                                : 0)
  42
  43 /* Return -1 if MDP uses anonymous mapping. Otherwise, return MDP->FD */
  44 #define MAP_ANON_OR_FD(MDP) (((MDP) -> flags & MMALLOC_ANONYMOUS) \
  45                              ? -1                                 \
  46                              : (MDP) -> fd)
  47
  48 /* Return 0if MDP uses anonymous mapping. Otherwise, return off */
  49 #define MAP_ANON_OR_OFFSET(MDP, off) (((MDP) -> flags & MMALLOC_ANONYMOUS) \
  50                              ? 0                                           \
  51                              : off)
  52
  53 /** @brief Add memoty to this heap
  54  *
  55  *  Get core for the memory region specified by MDP, using SIZE as the
  56  *  amount to either add to or subtract from the existing region.  Works
  57  *  like sbrk(), but using mmap().
  58  *
  59  *  It never returns NULL. Instead, it dies verbosely on errors.
  60  *
  61  *  @param mdp  The heap
  62  *  @param size Bytes to allocate for this heap (or <0 to free memory from this heap)
  63  */
  64 void *mmorecore(struct mdesc *mdp, ssize_t size)
  65 {
  66   ssize_t test = 0;
  67   void *result; // please keep it uninitialized to track issues
  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 (size == 0) {
  75     /* Just return the current "break" value. */
  76     result = mdp->breakval;
  77
  78   } else if (size < 0) {
  79     /* We are deallocating memory.  If the amount requested would cause
  80        us to try to deallocate back past the base of the mmap'd region
  81        then die verbosely.  Otherwise, deallocate the memory and return
  82        the old break value. */
  83     if (((char *) mdp->breakval) + size >= (char *) mdp->base) {
  84       result = (void *) mdp->breakval;
  85       mdp->breakval = (char *) mdp->breakval + size;
  86       moveto = PAGE_ALIGN(mdp->breakval);
  87       munmap(moveto,
  88              (size_t) (((char *) mdp->top) - ((char *) moveto)) - 1);
  89       mdp->top = moveto;
  90     } else {
  91       fprintf(stderr,"Internal error: mmap was asked to deallocate more memory than it previously allocated. Bailling out now!\n");
  92       abort();
  93     }
  94   } else {
  95     /* We are allocating memory. Make sure we have an open file
  96        descriptor if not working with anonymous memory. */
  97     if (!(mdp->flags & MMALLOC_ANONYMOUS) && mdp->fd < 0) {
  98       fprintf(stderr,"Internal error: mmap file descriptor <0 (%d), without MMALLOC_ANONYMOUS being in the flags.\n",mdp->fd);
  99       abort();
 100     } else if ((char *) mdp->breakval + size > (char *) mdp->top) {
 101       /* The request would move us past the end of the currently
 102          mapped memory, so map in enough more memory to satisfy
 103          the request.  This means we also have to grow the mapped-to
 104          file by an appropriate amount, since mmap cannot be used
 105          to extend a file. */
 106       moveto = PAGE_ALIGN((char *) mdp->breakval + size);
 107       mapbytes = (char *) moveto - (char *) mdp->top;
 108       foffset = (char *) mdp->top - (char *) mdp->base;
 109
 110       if (mdp->fd > 0) {
 111         /* FIXME:  Test results of lseek() */
 112         lseek(mdp->fd, foffset + mapbytes - 1, SEEK_SET);
 113         test = write(mdp->fd, &buf, 1);
 114         if (test == -1) {
 115           fprintf(stderr,"Internal error: write to mmap'ed fd failed! error: %s", strerror(errno));
 116           abort();
 117         }
 118       }
 119
 120       /* Let's call mmap. Note that it is possible that mdp->top
 121          is 0. In this case mmap will choose the address for us.
 122          This call might very well overwrite an already existing memory mapping
 123          (leading to weird bugs).
 124        */
 125       mapto = mmap(mdp->top, mapbytes, PROT_READ | PROT_WRITE,
 126                    MAP_PRIVATE_OR_SHARED(mdp) | MAP_IS_ANONYMOUS(mdp) |
 127                    MAP_FIXED, MAP_ANON_OR_FD(mdp), MAP_ANON_OR_OFFSET(mdp, foffset));
 128
 129       if (mapto == MAP_FAILED) {
 130         char buff[1024];
 131         fprintf(stderr,"Internal error: mmap returned MAP_FAILED! error: %s\n",strerror(errno));
 132         snprintf(buff,1024,"cat /proc/%d/maps",getpid());
 133         int status = system(buff);
 134         if (status == -1 || !(WIFEXITED(status) && WEXITSTATUS(status) == 0))
 135           fprintf(stderr, "Something went wrong when trying to %s\n", buff);
 136         sleep(1);
 137         abort();
 138       }
 139
 140       if (mdp->top == 0)
 141         mdp->base = mdp->breakval = mapto;
 142
 143       mdp->top = PAGE_ALIGN((char *) mdp->breakval + size);
 144       result = (void *) mdp->breakval;
 145       mdp->breakval = (char *) mdp->breakval + size;
 146     } else {
 147       /* Memory is already mapped, we only need to increase the breakval: */
 148       result = (void *) mdp->breakval;
 149       mdp->breakval = (char *) mdp->breakval + size;
 150     }
 151   }
 152   return (result);
 153 }
 154
 155 void *__mmalloc_remap_core(xbt_mheap_t mdp)
 156 {
 157   /* FIXME:  Quick hack, needs error checking and other attention. */
 158
 159   return mmap(mdp->base, (char*) mdp->top - (char*) mdp->base,
 160               PROT_READ | PROT_WRITE | PROT_EXEC,
 161               MAP_PRIVATE_OR_SHARED(mdp) | MAP_FIXED, mdp->fd, 0);
 162 }
 163