Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
normalize the function names wrt to the rest of XBT
[simgrid.git] / src / xbt / mmalloc / mm_module.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 #include "xbt_modinter.h" /* declarations of mmalloc_preinit and friends that live here */
33
34 #ifndef SEEK_SET
35 #define SEEK_SET 0
36 #endif
37
38 /* Initialize access to a mmalloc managed region.
39
40    If FD is a valid file descriptor for an open file then data for the
41    mmalloc managed region is mapped to that file, otherwise an anonymous
42    map is used if supported by the underlying OS. In case of running in
43    an OS without support of anonymous mappings then "/dev/zero" is used 
44    and in both cases the data will not exist in any filesystem object.
45
46    If the open file corresponding to FD is from a previous use of
47    mmalloc and passes some basic sanity checks to ensure that it is
48    compatible with the current mmalloc package, then its data is
49    mapped in and is immediately accessible at the same addresses in
50    the current process as the process that created the file (ignoring
51    the BASEADDR parameter).
52
53    For non valid FDs or empty files ones the mapping is established 
54    starting at the specified address BASEADDR in the process address 
55    space.
56
57    The provided BASEADDR should be choosed carefully in order to avoid
58    bumping into existing mapped regions or future mapped regions.
59
60    On success, returns a "malloc descriptor" which is used in subsequent
61    calls to other mmalloc package functions.  It is explicitly "void *"
62    so that users of the package don't have to worry about the actual
63    implementation details.
64
65    On failure returns NULL. */
66
67 xbt_mheap_t xbt_mheap_new(int fd, void *baseaddr)
68 {
69   struct mdesc mtemp;
70   xbt_mheap_t mdp;
71   void *mbase;
72   struct stat sbuf;
73
74   /* First check to see if FD is a valid file descriptor, and if so, see
75      if the file has any current contents (size > 0).  If it does, then
76      attempt to reuse the file.  If we can't reuse the file, either
77      because it isn't a valid mmalloc produced file, was produced by an
78      obsolete version, or any other reason, then we fail to attach to
79      this file. */
80
81   if (fd >= 0) {
82     if (fstat(fd, &sbuf) < 0)
83       return (NULL);
84
85     else if (sbuf.st_size > 0) {
86         /* We were given an valid file descriptor on an open file, so try to remap
87            it into the current process at the same address to which it was previously
88            mapped. It naturally have to pass some sanity checks for that.
89
90            Note that we have to update the file descriptor number in the malloc-
91            descriptor read from the file to match the current valid one, before
92            trying to map the file in, and again after a successful mapping and
93            after we've switched over to using the mapped in malloc descriptor
94            rather than the temporary one on the stack.
95
96            Once we've switched over to using the mapped in malloc descriptor, we
97            have to update the pointer to the morecore function, since it almost
98            certainly will be at a different address if the process reusing the
99            mapped region is from a different executable.
100
101            Also note that if the heap being remapped previously used the mmcheckf()
102            routines, we need to update the hooks since their target functions
103            will have certainly moved if the executable has changed in any way.
104            We do this by calling mmcheckf() internally.
105
106            Returns a pointer to the malloc descriptor if successful, or NULL if
107            unsuccessful for some reason. */
108
109           struct mdesc mtemp;
110           struct mdesc *mdp = NULL, *mdptemp = NULL;
111
112           if (lseek(fd, 0L, SEEK_SET) != 0)
113             return NULL;
114           if (read(fd, (char *) &mtemp, sizeof(mtemp)) != sizeof(mtemp))
115             return NULL;
116           if (mtemp.headersize != sizeof(mtemp))
117             return NULL;
118           if (strcmp(mtemp.magic, MMALLOC_MAGIC) != 0)
119             return NULL;
120           if (mtemp.version > MMALLOC_VERSION)
121             return NULL;
122
123           mtemp.fd = fd;
124           if (__mmalloc_remap_core(&mtemp) == mtemp.base) {
125             mdp = (struct mdesc *) mtemp.base;
126             mdp->fd = fd;
127             if(!mdp->refcount){
128               sem_init(&mdp->sem, 1, 1);
129               mdp->refcount++;
130             }
131           }
132
133           /* Add the new heap to the linked list of heaps attached by mmalloc */
134           mdptemp = __mmalloc_default_mdp;
135           while(mdptemp->next_mdesc)
136             mdptemp = mdptemp->next_mdesc;
137
138           LOCK(mdptemp);
139             mdptemp->next_mdesc = mdp;
140           UNLOCK(mdptemp);
141
142           return (mdp);
143     }
144   }
145
146   /* If the user provided NULL BASEADDR then fail */
147   if (baseaddr == NULL)
148     return (NULL);
149
150   /* We start off with the malloc descriptor allocated on the stack, until
151      we build it up enough to call _mmalloc_mmap_morecore() to allocate the
152      first page of the region and copy it there.  Ensure that it is zero'd and
153      then initialize the fields that we know values for. */
154
155   mdp = &mtemp;
156   memset((char *) mdp, 0, sizeof(mtemp));
157   strncpy(mdp->magic, MMALLOC_MAGIC, MMALLOC_MAGIC_SIZE);
158   mdp->headersize = sizeof(mtemp);
159   mdp->version = MMALLOC_VERSION;
160   mdp->fd = fd;
161   mdp->base = mdp->breakval = mdp->top = baseaddr;
162   mdp->next_mdesc = NULL;
163   mdp->refcount = 1;
164   
165   /* If we have not been passed a valid open file descriptor for the file
166      to map to, then we go for an anonymous map */
167
168   if (mdp->fd < 0){
169     mdp->flags |= MMALLOC_ANONYMOUS;
170     sem_init(&mdp->sem, 0, 1);
171   }else{
172     sem_init(&mdp->sem, 1, 1);
173   }
174   
175   /* If we have not been passed a valid open file descriptor for the file
176      to map to, then open /dev/zero and use that to map to. */
177
178   /* Now try to map in the first page, copy the malloc descriptor structure
179      there, and arrange to return a pointer to this new copy.  If the mapping
180      fails, then close the file descriptor if it was opened by us, and arrange
181      to return a NULL. */
182
183   if ((mbase = mmorecore(mdp, sizeof(mtemp))) != NULL) {
184     memcpy(mbase, mdp, sizeof(mtemp));
185   } else {
186     THROWF(system_error,0,"morecore failed to get some memory!");
187   }
188
189   /* Add the new heap to the linked list of heaps attached by mmalloc */  
190   if(__mmalloc_default_mdp){
191     mdp = __mmalloc_default_mdp;
192     while(mdp->next_mdesc)
193       mdp = mdp->next_mdesc;
194
195     LOCK(mdp);
196       mdp->next_mdesc = (struct mdesc *)mbase;
197     UNLOCK(mdp);
198   }
199
200   return mbase;
201 }
202
203
204
205 /** Terminate access to a mmalloc managed region, but do not free its content.
206  *
207  * This is for example useful for the base region where ldl stores its data
208  *   because it leaves the place after us.
209  */
210 void xbt_mheap_destroy_no_free(xbt_mheap_t md)
211 {
212   struct mdesc *mdp = md;
213
214   if(--mdp->refcount == 0){
215     LOCK(mdp) ;
216     sem_destroy(&mdp->sem);
217   }
218 }
219
220 /** Terminate access to a mmalloc managed region by unmapping all memory pages
221    associated with the region, and closing the file descriptor if it is one
222    that we opened.
223
224    Returns NULL on success.
225
226    Returns the malloc descriptor on failure, which can subsequently be used
227    for further action, such as obtaining more information about the nature of
228    the failure.
229
230    Note that the malloc descriptor that we are using is currently located in
231    region we are about to unmap, so we first make a local copy of it on the
232    stack and use the copy. */
233
234 void *xbt_mheap_destroy(xbt_mheap_t mdp)
235 {
236   struct mdesc mtemp, *mdptemp;
237
238   if (mdp != NULL) {
239     /* Remove the heap from the linked list of heaps attached by mmalloc */
240     mdptemp = __mmalloc_default_mdp;
241     while(mdptemp->next_mdesc != mdp )
242       mdptemp = mdptemp->next_mdesc;
243
244     mdptemp->next_mdesc = mdp->next_mdesc;
245
246     xbt_mheap_destroy_no_free(mdp);
247     mtemp = *mdp;
248
249     /* Now unmap all the pages associated with this region by asking for a
250        negative increment equal to the current size of the region. */
251
252     if ((mmorecore(&mtemp,
253                         (char *) mtemp.base - (char *) mtemp.breakval)) ==
254         NULL) {
255       /* Deallocating failed.  Update the original malloc descriptor
256          with any changes */
257       *mdp = mtemp;
258     } else {
259       if (mtemp.flags & MMALLOC_DEVZERO) {
260         close(mtemp.fd);
261       }
262       mdp = NULL;
263     }
264   }
265
266   return (mdp);
267 }
268
269 /* Safety gap from the heap's break address.
270  * Try to increase this first if you experience strange errors under
271  * valgrind. */
272 #define HEAP_OFFSET   (128UL<<20)
273
274 xbt_mheap_t mmalloc_get_default_md(void)
275 {
276   xbt_assert(__mmalloc_default_mdp);
277   return __mmalloc_default_mdp;
278 }
279
280 static void mmalloc_fork_prepare(void)
281 {
282   xbt_mheap_t mdp = NULL;
283   if ((mdp =__mmalloc_default_mdp)){
284     while(mdp){
285       LOCK(mdp);
286       if(mdp->fd >= 0){
287         mdp->refcount++;
288       }
289       mdp = mdp->next_mdesc;
290     }
291   }
292 }
293
294 static void mmalloc_fork_parent(void)
295 {
296   xbt_mheap_t mdp = NULL;
297   if ((mdp =__mmalloc_default_mdp)){
298     while(mdp){
299       if(mdp->fd < 0)
300         UNLOCK(mdp);
301       mdp = mdp->next_mdesc;
302     }
303   }
304 }
305
306 static void mmalloc_fork_child(void)
307 {
308   struct mdesc* mdp = NULL;
309   if ((mdp =__mmalloc_default_mdp)){
310     while(mdp){
311       UNLOCK(mdp);
312       mdp = mdp->next_mdesc;
313     }
314   }
315 }
316
317
318
319 /* Initialize the default malloc descriptor. */
320 void *mmalloc_preinit(void)
321 {
322   int res;
323   if (__mmalloc_default_mdp == NULL) {
324     unsigned long mask = ~((unsigned long)getpagesize() - 1);
325     void *addr = (void*)(((unsigned long)sbrk(0) + HEAP_OFFSET) & mask);
326     __mmalloc_default_mdp = xbt_mheap_new(-1, addr);
327     /* Fixme? only the default mdp in protected against forks */
328     res = xbt_os_thread_atfork(mmalloc_fork_prepare,
329                                mmalloc_fork_parent, mmalloc_fork_child);
330     if (res != 0)
331       THROWF(system_error,0,"xbt_os_thread_atfork() failed: return value %d",res);
332   }
333   xbt_assert(__mmalloc_default_mdp != NULL);
334
335   return __mmalloc_default_mdp;
336 }
337
338 void mmalloc_postexit(void)
339 {
340   /* Do not detach the default mdp or ldl won't be able to free the memory it allocated since we're in memory */
341   //  mmalloc_detach(__mmalloc_default_mdp);
342   xbt_mheap_destroy_no_free(__mmalloc_default_mdp);
343 }