src/xbt/mmalloc/attach.c

   1 /* Initialization for access to a mmap'd malloc managed region.
   2    Copyright 1992, 2000 Free Software Foundation, Inc.
   3
   4    Contributed by Fred Fish at Cygnus Support.   fnf@cygnus.com
   5
   6 This file is part of the GNU C Library.
   7
   8 The GNU C Library is free software; you can redistribute it and/or
   9 modify it under the terms of the GNU Library General Public License as
  10 published by the Free Software Foundation; either version 2 of the
  11 License, or (at your option) any later version.
  12
  13 The GNU C Library is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 Library General Public License for more details.
  17
  18 You should have received a copy of the GNU Library General Public
  19 License along with the GNU C Library; see the file COPYING.LIB.  If
  20 not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 #include <sys/types.h>
  24 #include <fcntl.h>              /* After sys/types.h, at least for dpx/2.  */
  25 #include <sys/stat.h>
  26 #include <string.h>
  27 #ifdef HAVE_UNISTD_H
  28 #include <unistd.h>             /* Prototypes for lseek */
  29 #endif
  30 #include "mmprivate.h"
  31 #include "xbt/ex.h"
  32
  33 #ifndef SEEK_SET
  34 #define SEEK_SET 0
  35 #endif
  36
  37
  38 /* Forward declarations/prototypes for local functions */
  39
  40 static struct mdesc *reuse(int fd);
  41
  42 /* Initialize access to a mmalloc managed region.
  43
  44    If FD is a valid file descriptor for an open file then data for the
  45    mmalloc managed region is mapped to that file, otherwise an anonymous
  46    map is used if supported by the underlying OS. In case of running in
  47    an OS without support of anonymous mappings then "/dev/zero" is used
  48    and in both cases the data will not exist in any filesystem object.
  49
  50    If the open file corresponding to FD is from a previous use of
  51    mmalloc and passes some basic sanity checks to ensure that it is
  52    compatible with the current mmalloc package, then its data is
  53    mapped in and is immediately accessible at the same addresses in
  54    the current process as the process that created the file (ignoring
  55    the BASEADDR parameter).
  56
  57    For non valid FDs or empty files ones the mapping is established
  58    starting at the specified address BASEADDR in the process address
  59    space.
  60
  61    The provided BASEADDR should be choosed carefully in order to avoid
  62    bumping into existing mapped regions or future mapped regions.
  63
  64    On success, returns a "malloc descriptor" which is used in subsequent
  65    calls to other mmalloc package functions.  It is explicitly "void *"
  66    so that users of the package don't have to worry about the actual
  67    implementation details.
  68
  69    On failure returns NULL. */
  70
  71 xbt_mheap_t mmalloc_attach(int fd, void *baseaddr)
  72 {
  73   struct mdesc mtemp;
  74   xbt_mheap_t mdp;
  75   void *mbase;
  76   struct stat sbuf;
  77
  78   /* First check to see if FD is a valid file descriptor, and if so, see
  79      if the file has any current contents (size > 0).  If it does, then
  80      attempt to reuse the file.  If we can't reuse the file, either
  81      because it isn't a valid mmalloc produced file, was produced by an
  82      obsolete version, or any other reason, then we fail to attach to
  83      this file. */
  84
  85   if (fd >= 0) {
  86     if (fstat(fd, &sbuf) < 0)
  87       return (NULL);
  88
  89     else if (sbuf.st_size > 0)
  90       return ((void *) reuse(fd));
  91   }
  92
  93   /* If the user provided NULL BASEADDR then fail */
  94   if (baseaddr == NULL)
  95     return (NULL);
  96
  97   /* We start off with the malloc descriptor allocated on the stack, until
  98      we build it up enough to call _mmalloc_mmap_morecore() to allocate the
  99      first page of the region and copy it there.  Ensure that it is zero'd and
 100      then initialize the fields that we know values for. */
 101
 102   mdp = &mtemp;
 103   memset((char *) mdp, 0, sizeof(mtemp));
 104   strncpy(mdp->magic, MMALLOC_MAGIC, MMALLOC_MAGIC_SIZE);
 105   mdp->headersize = sizeof(mtemp);
 106   mdp->version = MMALLOC_VERSION;
 107   mdp->fd = fd;
 108   mdp->base = mdp->breakval = mdp->top = baseaddr;
 109   mdp->next_mdesc = NULL;
 110   mdp->refcount = 1;
 111
 112   /* If we have not been passed a valid open file descriptor for the file
 113      to map to, then we go for an anonymous map */
 114
 115   if (mdp->fd < 0){
 116     mdp->flags |= MMALLOC_ANONYMOUS;
 117     sem_init(&mdp->sem, 0, 1);
 118   }else{
 119     sem_init(&mdp->sem, 1, 1);
 120   }
 121
 122   /* If we have not been passed a valid open file descriptor for the file
 123      to map to, then open /dev/zero and use that to map to. */
 124
 125   /* Now try to map in the first page, copy the malloc descriptor structure
 126      there, and arrange to return a pointer to this new copy.  If the mapping
 127      fails, then close the file descriptor if it was opened by us, and arrange
 128      to return a NULL. */
 129
 130   if ((mbase = mmorecore(mdp, sizeof(mtemp))) != NULL) {
 131     memcpy(mbase, mdp, sizeof(mtemp));
 132   } else {
 133     THROWF(system_error,0,"morecore failed to get some memory!");
 134   }
 135
 136   /* Add the new heap to the linked list of heaps attached by mmalloc */
 137   if(__mmalloc_default_mdp){
 138     mdp = __mmalloc_default_mdp;
 139     while(mdp->next_mdesc)
 140       mdp = mdp->next_mdesc;
 141
 142     LOCK(mdp);
 143       mdp->next_mdesc = (struct mdesc *)mbase;
 144     UNLOCK(mdp);
 145   }
 146
 147   return mbase;
 148 }
 149
 150 /* Given an valid file descriptor on an open file, test to see if that file
 151    is a valid mmalloc produced file, and if so, attempt to remap it into the
 152    current process at the same address to which it was previously mapped.
 153
 154    Note that we have to update the file descriptor number in the malloc-
 155    descriptor read from the file to match the current valid one, before
 156    trying to map the file in, and again after a successful mapping and
 157    after we've switched over to using the mapped in malloc descriptor
 158    rather than the temporary one on the stack.
 159
 160    Once we've switched over to using the mapped in malloc descriptor, we
 161    have to update the pointer to the morecore function, since it almost
 162    certainly will be at a different address if the process reusing the
 163    mapped region is from a different executable.
 164
 165    Also note that if the heap being remapped previously used the mmcheckf()
 166    routines, we need to update the hooks since their target functions
 167    will have certainly moved if the executable has changed in any way.
 168    We do this by calling mmcheckf() internally.
 169
 170    Returns a pointer to the malloc descriptor if successful, or NULL if
 171    unsuccessful for some reason. */
 172
 173 static struct mdesc *reuse(int fd)
 174 {
 175   struct mdesc mtemp;
 176   struct mdesc *mdp = NULL, *mdptemp = NULL;
 177
 178   if (lseek(fd, 0L, SEEK_SET) != 0)
 179     return NULL;
 180   if (read(fd, (char *) &mtemp, sizeof(mtemp)) != sizeof(mtemp))
 181     return NULL;
 182   if (mtemp.headersize != sizeof(mtemp))
 183     return NULL;
 184   if (strcmp(mtemp.magic, MMALLOC_MAGIC) != 0)
 185     return NULL;
 186   if (mtemp.version > MMALLOC_VERSION)
 187     return NULL;
 188
 189   mtemp.fd = fd;
 190   if (__mmalloc_remap_core(&mtemp) == mtemp.base) {
 191     mdp = (struct mdesc *) mtemp.base;
 192     mdp->fd = fd;
 193     if(!mdp->refcount){
 194       sem_init(&mdp->sem, 1, 1);
 195       mdp->refcount++;
 196     }
 197   }
 198
 199   /* Add the new heap to the linked list of heaps attached by mmalloc */
 200   mdptemp = __mmalloc_default_mdp;
 201   while(mdptemp->next_mdesc)
 202     mdptemp = mdptemp->next_mdesc;
 203
 204   LOCK(mdptemp);
 205     mdptemp->next_mdesc = mdp;
 206   UNLOCK(mdptemp);
 207
 208   return (mdp);
 209 }