Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
95c5db66717ff13d7ed511cc653ab25ebe8667f2
[simgrid.git] / src / xbt / mmalloc / mmalloc.c
1 /* Memory allocator `malloc'.
2    Copyright 1990, 1991, 1992 Free Software Foundation
3
4    Written May 1989 by Mike Haertel.
5    Heavily modified Mar 1992 by Fred Fish for mmap'd version. */
6
7 /* Copyright (c) 2010. The SimGrid Team.
8  * All rights reserved.                                                     */
9
10 /* This program is free software; you can redistribute it and/or modify it
11  * under the terms of the license (GNU LGPL) which comes with this package. */
12
13 #include <string.h>             /* Prototypes for memcpy, memmove, memset, etc */
14 #include <stdio.h>
15 #include "mmprivate.h"
16
17 /* Prototypes for local functions */
18
19 static void initialize(xbt_mheap_t mdp);
20 static void *register_morecore(xbt_mheap_t mdp, size_t size);
21 static void *align(xbt_mheap_t mdp, size_t size);
22
23 /* Allocation aligned on block boundary.
24  *
25  * It never returns NULL, but dies verbosely on error.
26  */
27 static void *align(struct mdesc *mdp, size_t size)
28 {
29   void *result;
30   unsigned long int adj;
31
32   result = mmorecore(mdp, size);
33
34   /* if this reservation does not fill up the last block of our resa,
35    * complete the reservation by also asking for the full lastest block.
36    *
37    * Also, the returned block is aligned to the end of block (but I've
38    * no fucking idea of why, actually -- http://abstrusegoose.com/432 --
39    * but not doing so seems to lead to issues).
40    */
41   adj = RESIDUAL(result, BLOCKSIZE);
42   if (adj != 0) {
43     adj = BLOCKSIZE - adj;
44     mmorecore(mdp, adj);
45     result = (char *) result + adj;
46   }
47   return (result);
48 }
49
50 /* Finish the initialization of the mheap. If we want to inline it
51  * properly, we need to make the align function publicly visible, too  */
52 static void initialize(xbt_mheap_t mdp)
53 {
54   int i;
55   malloc_info mi; /* to compute the offset of the swag hook */
56
57   mdp->heapsize = HEAP / BLOCKSIZE;
58   mdp->heapinfo = (malloc_info *)
59     align(mdp, mdp->heapsize * sizeof(malloc_info));
60
61   memset((void *) mdp->heapinfo, 0, mdp->heapsize * sizeof(malloc_info));
62   mdp->heapinfo[0].type=-1;
63   mdp->heapinfo[0].free_block.size = 0;
64   mdp->heapinfo[0].free_block.next = mdp->heapinfo[0].free_block.prev = 0;
65   mdp->heapindex = 0;
66   mdp->heapbase = (void *) mdp->heapinfo;
67   mdp->flags |= MMALLOC_INITIALIZED;
68
69   for (i=0;i<BLOCKLOG;i++) {
70       xbt_swag_init(&(mdp->fraghead[i]),
71                     xbt_swag_offset(mi, freehook));
72   }
73 }
74
75 #define update_hook(a,offset) do { if (a) { a = ((char*)a +(offset));} }while(0)
76
77 /* Get neatly aligned memory from the low level layers, and register it
78  * into the heap info table as necessary. */
79 static void *register_morecore(struct mdesc *mdp, size_t size)
80 {
81   int i;
82   void *result;
83   malloc_info *newinfo, *oldinfo;
84   size_t newsize;
85
86   result = align(mdp, size); // Never returns NULL
87
88   /* Check if we need to grow the info table (in a multiplicative manner)  */
89   if ((size_t) BLOCK((char *) result + size) > mdp->heapsize) {
90     int it;
91
92     newsize = mdp->heapsize;
93     while ((size_t) BLOCK((char *) result + size) > newsize)
94       newsize *= 2;
95
96     /* Copy old info into new location */
97     oldinfo = mdp->heapinfo;
98     newinfo = (malloc_info *) align(mdp, newsize * sizeof(malloc_info));
99     memset(newinfo, 0, newsize * sizeof(malloc_info));
100     memcpy(newinfo, oldinfo, mdp->heapsize * sizeof(malloc_info));
101
102     /* Update the swag of busy blocks containing free fragments by applying the offset to all swag_hooks. Yeah. My hand is right in the fan and I still type */
103     size_t offset=((char*)newinfo)-((char*)oldinfo);
104
105     for (i=1/*first element of heapinfo describes the mdesc area*/;
106          i<mdp->heaplimit;
107          i++) {
108       update_hook(newinfo[i].freehook.next,offset);
109       update_hook(newinfo[i].freehook.prev,offset);
110     }
111     // also update the starting points of the swag
112     for (i=0;i<BLOCKLOG;i++) {
113       update_hook(mdp->fraghead[i].head,offset);
114       update_hook(mdp->fraghead[i].tail,offset);
115     }
116     mdp->heapinfo = newinfo;
117
118     /* mark the space previously occupied by the block info as free by first marking it
119      * as occupied in the regular way, and then freing it */
120     for (it=0; it<BLOCKIFY(mdp->heapsize * sizeof(malloc_info)); it++)
121       newinfo[BLOCK(oldinfo)+it].type = 0;
122
123     newinfo[BLOCK(oldinfo)].busy_block.size = BLOCKIFY(mdp->heapsize * sizeof(malloc_info));
124     newinfo[BLOCK(oldinfo)].busy_block.busy_size = size;
125     newinfo[BLOCK(oldinfo)].busy_block.bt_size = 0;// FIXME setup the backtrace
126     mfree(mdp, (void *) oldinfo);
127     mdp->heapsize = newsize;
128   }
129
130   mdp->heaplimit = BLOCK((char *) result + size);
131   return (result);
132 }
133 #undef update_hook
134
135 /* Allocate memory from the heap.  */
136 void *mmalloc(xbt_mheap_t mdp, size_t size) {
137   void *res= mmalloc_no_memset(mdp,size);
138 //  fprintf(stderr,"malloc(%zu)~>%p\n",size,res);
139   memset(res,0,size);
140   return res;
141 }
142 /* Spliting mmalloc this way is mandated by a trick in mrealloc, that gives
143    back the memory of big blocks to the system before reallocating them: we don't
144    want to loose the beginning of the area when this happens */
145 void *mmalloc_no_memset(xbt_mheap_t mdp, size_t size)
146 {
147   void *result;
148   size_t block, blocks, lastblocks, start;
149   register size_t i;
150   register size_t log;
151   int it;
152
153   size_t requested_size = size; // The amount of memory requested by user, for real
154
155   /* Work even if the user was stupid enough to ask a ridicullously small block (even 0-length),
156    *    ie return a valid block that can be realloced and freed.
157    * glibc malloc does not use this trick but return a constant pointer, but we need to enlist the free fragments later on.
158    */
159   if (size < SMALLEST_POSSIBLE_MALLOC)
160     size = SMALLEST_POSSIBLE_MALLOC;
161
162   //  printf("(%s) Mallocing %d bytes on %p (default: %p)...",xbt_thread_self_name(),size,mdp,__mmalloc_default_mdp);fflush(stdout);
163
164   if (!(mdp->flags & MMALLOC_INITIALIZED))
165     initialize(mdp);
166
167   mmalloc_paranoia(mdp);
168
169   /* Determine the allocation policy based on the request size.  */
170   if (size <= BLOCKSIZE / 2) {
171     /* Small allocation to receive a fragment of a block.
172        Determine the logarithm to base two of the fragment size. */
173     log = 1;
174     --size;
175     while ((size /= 2) != 0) {
176       ++log;
177     }
178
179     /* Look in the fragment lists for a free fragment of the desired size. */
180     if (xbt_swag_size(&mdp->fraghead[log])>0) {
181       /* There are free fragments of this size; Get one of them and prepare to return it.
182          Update the block's nfree and if no other free fragment, get out of the swag. */
183
184       /* search a fragment that I could return as a result */
185       malloc_info *candidate_info = xbt_swag_getFirst(&mdp->fraghead[log]);
186       size_t candidate_block = (candidate_info - &(mdp->heapinfo[0]));
187       size_t candidate_frag;
188       for (candidate_frag=0;candidate_frag<(size_t) (BLOCKSIZE >> log);candidate_frag++)
189         if (candidate_info->busy_frag.frag_size[candidate_frag] == -1)
190           break;
191       xbt_assert(candidate_frag < (size_t) (BLOCKSIZE >> log),
192           "Block %zu was registered as containing free fragments of type %zu, but I can't find any",candidate_block,log);
193
194       result = (void*) (((char*)ADDRESS(candidate_block)) + (candidate_frag << log));
195
196       /* Remove this fragment from the list of free guys */
197       candidate_info->busy_frag.nfree--;
198       if (candidate_info->busy_frag.nfree == 0) {
199         xbt_swag_remove(candidate_info,&mdp->fraghead[log]);
200       }
201
202       /* Update our metadata about this fragment */
203       candidate_info->busy_frag.frag_size[candidate_frag] = requested_size;
204       xbt_backtrace_no_malloc(candidate_info->busy_frag.bt[candidate_frag],XBT_BACKTRACE_SIZE);
205
206       /* Update the statistics.  */
207       mdp -> heapstats.chunks_used++;
208       mdp -> heapstats.bytes_used += 1 << log;
209       mdp -> heapstats.chunks_free--;
210       mdp -> heapstats.bytes_free -= 1 << log;
211
212     } else {
213       /* No free fragments of the desired size, so get a new block
214          and break it into fragments, returning the first.  */
215
216       result = mmalloc(mdp, BLOCKSIZE); // does not return NULL
217       block = BLOCK(result);
218
219       mdp->heapinfo[block].type = log;
220       /* Link all fragments but the first as free, and add the block to the swag of blocks containing free frags  */
221       for (i = 1; i < (size_t) (BLOCKSIZE >> log); ++i) {
222         mdp->heapinfo[block].busy_frag.frag_size[i] = -1;
223       }
224       mdp->heapinfo[block].busy_frag.nfree = i - 1;
225       mdp->heapinfo[block].freehook.prev = NULL;
226       mdp->heapinfo[block].freehook.next = NULL;
227
228       xbt_swag_insert(&mdp->heapinfo[block], &(mdp->fraghead[log]));
229
230       /* mark the fragment returned as busy */
231       mdp->heapinfo[block].busy_frag.frag_size[0] = requested_size;
232       xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[0],XBT_BACKTRACE_SIZE);
233       
234       /* update stats */
235       mdp -> heapstats.chunks_free += (BLOCKSIZE >> log) - 1;
236       mdp -> heapstats.bytes_free += BLOCKSIZE - (1 << log);
237       mdp -> heapstats.bytes_used -= BLOCKSIZE - (1 << log);
238     }
239   } else {
240     /* Large allocation to receive one or more blocks.
241        Search the free list in a circle starting at the last place visited.
242        If we loop completely around without finding a large enough
243        space we will have to get more memory from the system.  */
244     blocks = BLOCKIFY(size);
245     start = block = MALLOC_SEARCH_START;
246     while (mdp->heapinfo[block].free_block.size < blocks) {
247       if (mdp->heapinfo[block].type >=0) { // Don't trust xbt_die and friends in malloc-level library, you fool!
248         fprintf(stderr,"Internal error: found a free block not marked as such (block=%lu type=%lu). Please report this bug.\n",(unsigned long)block,(unsigned long)mdp->heapinfo[block].type);
249         abort();
250       }
251
252       block = mdp->heapinfo[block].free_block.next;
253       if (block == start) {
254         /* Need to get more from the system.  Check to see if
255            the new core will be contiguous with the final free
256            block; if so we don't need to get as much.  */
257         block = mdp->heapinfo[0].free_block.prev;
258         lastblocks = mdp->heapinfo[block].free_block.size;
259         if (mdp->heaplimit != 0 &&
260             block + lastblocks == mdp->heaplimit &&
261             mmorecore(mdp, 0) == ADDRESS(block + lastblocks) &&
262             (register_morecore(mdp, (blocks - lastblocks) * BLOCKSIZE)) != NULL) {
263           /* Which block we are extending (the `final free
264              block' referred to above) might have changed, if
265              it got combined with a freed info table.  */
266           block = mdp->heapinfo[0].free_block.prev;
267
268           mdp->heapinfo[block].free_block.size += (blocks - lastblocks);
269           continue;
270         }
271         result = register_morecore(mdp, blocks * BLOCKSIZE);
272
273         block = BLOCK(result);
274         for (it=0;it<blocks;it++){
275           mdp->heapinfo[block+it].type = 0;
276         }
277         mdp->heapinfo[block].busy_block.size = blocks;
278         mdp->heapinfo[block].busy_block.busy_size = requested_size;
279         mdp->heapinfo[block].busy_block.bt_size=xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
280         mdp -> heapstats.chunks_used++;
281         mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
282
283         return result;
284       }
285       /* Need large block(s), but found some in the existing heap */
286     }
287
288     /* At this point we have found a suitable free list entry.
289        Figure out how to remove what we need from the list. */
290     result = ADDRESS(block);
291     if (mdp->heapinfo[block].free_block.size > blocks) {
292       /* The block we found has a bit left over,
293          so relink the tail end back into the free list. */
294       mdp->heapinfo[block + blocks].free_block.size
295         = mdp->heapinfo[block].free_block.size - blocks;
296       mdp->heapinfo[block + blocks].free_block.next
297         = mdp->heapinfo[block].free_block.next;
298       mdp->heapinfo[block + blocks].free_block.prev
299         = mdp->heapinfo[block].free_block.prev;
300       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
301         = mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
302         = mdp->heapindex = block + blocks;
303     } else {
304       /* The block exactly matches our requirements,
305          so just remove it from the list. */
306       mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
307         = mdp->heapinfo[block].free_block.prev;
308       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
309         = mdp->heapindex = mdp->heapinfo[block].free_block.next;
310     }
311
312     for (it=0;it<blocks;it++){
313       mdp->heapinfo[block+it].type = 0;
314     }
315     mdp->heapinfo[block].busy_block.size = blocks;
316     mdp->heapinfo[block].busy_block.busy_size = requested_size;
317     //mdp->heapinfo[block].busy_block.bt_size = 0;
318     mdp->heapinfo[block].busy_block.bt_size = xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
319
320     mdp -> heapstats.chunks_used++;
321     mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
322     mdp -> heapstats.bytes_free -= blocks * BLOCKSIZE;
323
324   }
325   //printf("(%s) Done mallocing. Result is %p\n",xbt_thread_self_name(),result);fflush(stdout);
326
327   return (result);
328 }