Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : add stats in mmalloc
[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   mdp->heapsize = HEAP / BLOCKSIZE;
55   mdp->heapinfo = (malloc_info *)
56     align(mdp, mdp->heapsize * sizeof(malloc_info));
57
58   memset((void *) mdp->heapinfo, 0, mdp->heapsize * sizeof(malloc_info));
59   mdp->heapinfo[0].type=-1;
60   mdp->heapinfo[0].free_block.size = 0;
61   mdp->heapinfo[0].free_block.next = mdp->heapinfo[0].free_block.prev = 0;
62   mdp->heapindex = 0;
63   mdp->heapbase = (void *) mdp->heapinfo;
64   mdp->flags |= MMALLOC_INITIALIZED;
65 }
66
67 /* Get neatly aligned memory from the low level layers, and register it
68  * into the heap info table as necessary. */
69 static void *register_morecore(struct mdesc *mdp, size_t size)
70 {
71   void *result;
72   malloc_info *newinfo, *oldinfo;
73   size_t newsize;
74
75   result = align(mdp, size); // Never returns NULL
76
77   /* Check if we need to grow the info table (in a multiplicative manner)  */
78   if ((size_t) BLOCK((char *) result + size) > mdp->heapsize) {
79     int it;
80
81     newsize = mdp->heapsize;
82     while ((size_t) BLOCK((char *) result + size) > newsize)
83       newsize *= 2;
84
85     /* Copy old info into new location */
86     oldinfo = mdp->heapinfo;
87     newinfo = (malloc_info *) align(mdp, newsize * sizeof(malloc_info));
88     memset(newinfo, 0, newsize * sizeof(malloc_info));
89     memcpy(newinfo, oldinfo, mdp->heapsize * sizeof(malloc_info));
90     mdp->heapinfo = newinfo;
91
92     /* mark the space previously occupied by the block info as free by first marking it
93      * as occupied in the regular way, and then freing it */
94     for (it=0; it<BLOCKIFY(mdp->heapsize * sizeof(malloc_info)); it++)
95       newinfo[BLOCK(oldinfo)+it].type = 0;
96
97     newinfo[BLOCK(oldinfo)].busy_block.size = BLOCKIFY(mdp->heapsize * sizeof(malloc_info));
98     newinfo[BLOCK(oldinfo)].busy_block.busy_size = size;
99     newinfo[BLOCK(oldinfo)].busy_block.bt_size = 0;// FIXME setup the backtrace
100     mfree(mdp, (void *) oldinfo);
101     mdp->heapsize = newsize;
102   }
103
104   mdp->heaplimit = BLOCK((char *) result + size);
105   return (result);
106 }
107
108 /* Allocate memory from the heap.  */
109
110 void *mmalloc(xbt_mheap_t mdp, size_t size)
111 {
112   void *result;
113   size_t block, blocks, lastblocks, start;
114   register size_t i;
115   struct list *next;
116   register size_t log;
117   int it;
118
119   size_t requested_size = size; // The amount of memory requested by user, for real
120
121   /* Work even if the user was stupid enough to ask a ridicullously small block (even 0-length),
122    *    ie return a valid block that can be realloced and freed.
123    * glibc malloc does not use this trick but return a constant pointer, but we need to enlist the free fragments later on.
124    */
125   if (size < SMALLEST_POSSIBLE_MALLOC)
126     size = SMALLEST_POSSIBLE_MALLOC;
127
128   //  printf("(%s) Mallocing %d bytes on %p (default: %p)...",xbt_thread_self_name(),size,mdp,__mmalloc_default_mdp);fflush(stdout);
129
130   if (!(mdp->flags & MMALLOC_INITIALIZED))
131     initialize(mdp);
132
133   /* Determine the allocation policy based on the request size.  */
134   if (size <= BLOCKSIZE / 2) {
135     /* Small allocation to receive a fragment of a block.
136        Determine the logarithm to base two of the fragment size. */
137     log = 1;
138     --size;
139     while ((size /= 2) != 0) {
140       ++log;
141     }
142
143     /* Look in the fragment lists for a
144        free fragment of the desired size. */
145     next = mdp->fraghead[log].next;
146     if (next != NULL) {
147       /* There are free fragments of this size.
148          Pop a fragment out of the fragment list and return it.
149          Update the block's nfree and first counters. */
150       int frag_nb;
151       result = (void *) next;
152       block = BLOCK(result);
153
154       frag_nb = RESIDUAL(result, BLOCKSIZE) >> log;
155       mdp->heapinfo[block].busy_frag.frag_size[frag_nb] = requested_size;
156       xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[frag_nb],XBT_BACKTRACE_SIZE);
157
158       next->prev->next = next->next;
159       if (next->next != NULL) {
160         next->next->prev = next->prev;
161       }
162       if (--mdp->heapinfo[block].busy_frag.nfree != 0) {
163         mdp->heapinfo[block].busy_frag.first =
164           RESIDUAL(next->next, BLOCKSIZE) >> log;
165       }
166
167       /* Update the statistics.  */
168       mdp -> heapstats.chunks_used++;
169       mdp -> heapstats.bytes_used += 1 << log;
170       mdp -> heapstats.chunks_free--;
171       mdp -> heapstats.bytes_free -= 1 << log;
172       
173     } else {
174       /* No free fragments of the desired size, so get a new block
175          and break it into fragments, returning the first.  */
176       //printf("(%s) No free fragment...",xbt_thread_self_name());
177
178       result = mmalloc(mdp, BLOCKSIZE); // does not return NULL
179
180       /* Link all fragments but the first into the free list, and mark their requested size to 0.  */
181       block = BLOCK(result);
182       for (i = 1; i < (size_t) (BLOCKSIZE >> log); ++i) {
183         mdp->heapinfo[block].busy_frag.frag_size[i] = 0;
184         next = (struct list *) ((char *) result + (i << log));
185         next->next = mdp->fraghead[log].next;
186         next->prev = &mdp->fraghead[log];
187         next->prev->next = next;
188         if (next->next != NULL) {
189           next->next->prev = next;
190         }
191       }
192       mdp->heapinfo[block].busy_frag.frag_size[0] = requested_size;
193       xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_frag.bt[0],XBT_BACKTRACE_SIZE);
194       
195       /* Initialize the nfree and first counters for this block.  */
196       mdp->heapinfo[block].type = log;
197       mdp->heapinfo[block].busy_frag.nfree = i - 1;
198       mdp->heapinfo[block].busy_frag.first = i - 1;
199
200       mdp -> heapstats.chunks_free += (BLOCKSIZE >> log) - 1;
201       mdp -> heapstats.bytes_free += BLOCKSIZE - (1 << log);
202       mdp -> heapstats.bytes_used -= BLOCKSIZE - (1 << log);
203     }
204   } else {
205     /* Large allocation to receive one or more blocks.
206        Search the free list in a circle starting at the last place visited.
207        If we loop completely around without finding a large enough
208        space we will have to get more memory from the system.  */
209     blocks = BLOCKIFY(size);
210     start = block = MALLOC_SEARCH_START;
211     while (mdp->heapinfo[block].free_block.size < blocks) {
212       if (mdp->heapinfo[block].type >=0) { // Don't trust xbt_die and friends in malloc-level library, you fool!
213         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);
214         abort();
215       }
216
217       block = mdp->heapinfo[block].free_block.next;
218       if (block == start) {
219         /* Need to get more from the system.  Check to see if
220            the new core will be contiguous with the final free
221            block; if so we don't need to get as much.  */
222         block = mdp->heapinfo[0].free_block.prev;
223         lastblocks = mdp->heapinfo[block].free_block.size;
224         if (mdp->heaplimit != 0 &&
225             block + lastblocks == mdp->heaplimit &&
226             mmorecore(mdp, 0) == ADDRESS(block + lastblocks) &&
227             (register_morecore(mdp, (blocks - lastblocks) * BLOCKSIZE)) != NULL) {
228           /* Which block we are extending (the `final free
229              block' referred to above) might have changed, if
230              it got combined with a freed info table.  */
231           block = mdp->heapinfo[0].free_block.prev;
232
233           mdp->heapinfo[block].free_block.size += (blocks - lastblocks);
234           continue;
235         }
236         result = register_morecore(mdp, blocks * BLOCKSIZE);
237
238         block = BLOCK(result);
239         for (it=0;it<blocks;it++)
240           mdp->heapinfo[block+it].type = 0;
241         mdp->heapinfo[block].busy_block.size = blocks;
242         mdp->heapinfo[block].busy_block.busy_size = requested_size;
243         mdp->heapinfo[block].busy_block.bt_size=xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
244         mdp -> heapstats.chunks_used++;
245         mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
246         return result;
247       }
248       /* Need large block(s), but found some in the existing heap */
249     }
250
251     /* At this point we have found a suitable free list entry.
252        Figure out how to remove what we need from the list. */
253     result = ADDRESS(block);
254     if (mdp->heapinfo[block].free_block.size > blocks) {
255       /* The block we found has a bit left over,
256          so relink the tail end back into the free list. */
257       mdp->heapinfo[block + blocks].free_block.size
258         = mdp->heapinfo[block].free_block.size - blocks;
259       mdp->heapinfo[block + blocks].free_block.next
260         = mdp->heapinfo[block].free_block.next;
261       mdp->heapinfo[block + blocks].free_block.prev
262         = mdp->heapinfo[block].free_block.prev;
263       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
264         = mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
265         = mdp->heapindex = block + blocks;
266     } else {
267       /* The block exactly matches our requirements,
268          so just remove it from the list. */
269       mdp->heapinfo[mdp->heapinfo[block].free_block.next].free_block.prev
270         = mdp->heapinfo[block].free_block.prev;
271       mdp->heapinfo[mdp->heapinfo[block].free_block.prev].free_block.next
272         = mdp->heapindex = mdp->heapinfo[block].free_block.next;
273     }
274
275     for (it=0;it<blocks;it++)
276       mdp->heapinfo[block+it].type = 0;
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 = 0;
280     mdp->heapinfo[block].busy_block.bt_size = xbt_backtrace_no_malloc(mdp->heapinfo[block].busy_block.bt,XBT_BACKTRACE_SIZE);
281
282     mdp -> heapstats.chunks_used++;
283     mdp -> heapstats.bytes_used += blocks * BLOCKSIZE;
284     mdp -> heapstats.bytes_free -= blocks * BLOCKSIZE;
285   }
286   //printf("(%s) Done mallocing. Result is %p\n",xbt_thread_self_name(),result);fflush(stdout);
287   return (result);
288 }