Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : remove unused argument in functions for heap comparison algorithm
[simgrid.git] / src / xbt / mmalloc / mmprivate.h
1 /* Declarations for `mmalloc' and friends.
2    Copyright 1990, 1991, 1992 Free Software Foundation
3
4    Written May 1989 by Mike Haertel.
5    Heavily modified Mar 1992 by Fred Fish. (fnf@cygnus.com) */
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 #ifndef __MMPRIVATE_H
14 #define __MMPRIVATE_H 1
15
16 #include "portable.h"
17 #include "xbt/xbt_os_thread.h"
18 #include "xbt/mmalloc.h"
19 #include "xbt/ex.h"
20 #include <semaphore.h>
21 #include <stdint.h>
22
23 #ifdef HAVE_LIMITS_H
24 #  include <limits.h>
25 #else
26 #  ifndef CHAR_BIT
27 #    define CHAR_BIT 8
28 #  endif
29 #endif
30
31 #define MMALLOC_MAGIC           "mmalloc"       /* Mapped file magic number */
32 #define MMALLOC_MAGIC_SIZE      8       /* Size of magic number buf */
33 #define MMALLOC_VERSION         2       /* Current mmalloc version */
34
35 /* The allocator divides the heap into blocks of fixed size; large
36    requests receive one or more whole blocks, and small requests
37    receive a fragment of a block.  Fragment sizes are powers of two,
38    and all fragments of a block are the same size.  When all the
39    fragments in a block have been freed, the block itself is freed.
40
41    FIXME: we are not targeting 16bits machines anymore; update values */
42
43 #define INT_BIT         (CHAR_BIT * sizeof(int))
44 #define BLOCKLOG        (INT_BIT > 16 ? 12 : 9)
45 #define BLOCKSIZE       ((unsigned int) 1 << BLOCKLOG)
46 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
47
48 /* We keep fragment-specific meta-data for introspection purposes, and these
49  * information are kept in fixed lenght arrays. Here is the computation of
50  * that size.
51  *
52  * Never make SMALLEST_POSSIBLE_MALLOC smaller than sizeof(list) because we
53  * need to enlist the free fragments.
54  */
55
56 //#define SMALLEST_POSSIBLE_MALLOC (sizeof(struct list))
57 #define SMALLEST_POSSIBLE_MALLOC (16*sizeof(struct list))
58 #define MAX_FRAGMENT_PER_BLOCK (BLOCKSIZE / SMALLEST_POSSIBLE_MALLOC)
59
60 /* The difference between two pointers is a signed int.  On machines where
61    the data addresses have the high bit set, we need to ensure that the
62    difference becomes an unsigned int when we are using the address as an
63    integral value.  In addition, when using with the '%' operator, the
64    sign of the result is machine dependent for negative values, so force
65    it to be treated as an unsigned int. */
66
67 #define ADDR2UINT(addr) ((uintptr_t) ((char*) (addr) - (char*) NULL))
68 #define RESIDUAL(addr,bsize) ((uintptr_t) (ADDR2UINT (addr) % (bsize)))
69
70 /* Determine the amount of memory spanned by the initial heap table
71    (not an absolute limit).  */
72
73 #define HEAP            (INT_BIT > 16 ? 4194304 : 65536)
74
75 /* Number of contiguous free blocks allowed to build up at the end of
76    memory before they will be returned to the system.
77    FIXME: this is not used anymore: we never return memory to the system. */
78 #define FINAL_FREE_BLOCKS       8
79
80 /* Where to start searching the free list when looking for new memory.
81    The two possible values are 0 and heapindex.  Starting at 0 seems
82    to reduce total memory usage, while starting at heapindex seems to
83    run faster.  */
84
85 #define MALLOC_SEARCH_START     mdp -> heapindex
86
87 /* Address to block number and vice versa.  */
88
89 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
90
91 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
92
93 /* Doubly linked lists of free fragments.  */
94 struct list {
95   struct list *next;
96   struct list *prev;
97 };
98
99 /* Data structure giving per-block information.
100  *
101  * There is one such structure in the mdp->heapinfo array per block used in that heap,
102  *    the array index is the block number.
103  *
104  * There is several types of blocks in memory:
105  *  - full busy blocks: used when we are asked to malloc a block which size is > BLOCKSIZE/2
106  *    In this situation, the full block is given to the malloc.
107  *
108  *  - fragmented busy blocks: when asked for smaller amount of memory.
109  *    Fragment sizes are only power of 2. When looking for such a free fragment,
110  *    we get one from mdp->fraghead (that contains a linked list of blocks fragmented at that
111  *    size and containing a free fragment), or we get a fresh block that we fragment.
112  *
113  *  - free blocks are grouped by clusters, that are chained together.
114  *    When looking for free blocks, we traverse the mdp->heapinfo looking
115  *    for a cluster of free blocks that would be large enough.
116  *
117  *    The size of the cluster is only to be trusted in the first block of the cluster, not in the middle blocks.
118  *
119  * The type field is consistently updated for every blocks, even within clusters of blocks.
120  * You can crawl the array and rely on that value.
121  *
122  * TODO:
123  *  - make room to store the backtrace of where the blocks and fragment were malloced, too.
124  */
125 typedef struct {
126   int type; /*  0: busy large block
127                 >0: busy fragmented (fragments of size 2^type bytes)
128                 <0: free block */
129   union {
130     /* Heap information for a busy block.  */
131     struct {
132       size_t nfree;           /* Free fragments in a fragmented block.  */
133       size_t first;           /* First free fragment of the block.  */
134       unsigned short frag_size[MAX_FRAGMENT_PER_BLOCK];
135       void *bt[MAX_FRAGMENT_PER_BLOCK][XBT_BACKTRACE_SIZE]; /* Where it was malloced (or realloced lastly) */
136     } busy_frag;
137     struct {
138       size_t size; /* Size (in blocks) of a large cluster.  */
139       size_t busy_size; /* Actually used space, in bytes */
140       void *bt[XBT_BACKTRACE_SIZE]; /* Where it was malloced (or realloced lastly) */
141       int bt_size;
142     } busy_block;
143     /* Heap information for a free block (that may be the first of a free cluster).  */
144     struct {
145       size_t size;                /* Size (in blocks) of a free cluster.  */
146       size_t next;                /* Index of next free cluster.  */
147       size_t prev;                /* Index of previous free cluster.  */
148     } free_block;
149   };
150 } malloc_info;
151
152 /* Internal structure that defines the format of the malloc-descriptor.
153    This gets written to the base address of the region that mmalloc is
154    managing, and thus also becomes the file header for the mapped file,
155    if such a file exists. */
156
157 struct mdesc {
158
159   /* Semaphore locking the access to the heap */
160   sem_t sem;
161
162   /* Number of processes that attached the heap */
163   unsigned int refcount;
164
165   /* Chained lists of mdescs */
166   struct mdesc *next_mdesc;
167
168   /* The "magic number" for an mmalloc file. */
169   char magic[MMALLOC_MAGIC_SIZE];
170
171   /* The size in bytes of this structure, used as a sanity check when reusing
172      a previously created mapped file. */
173   unsigned int headersize;
174
175   /* The version number of the mmalloc package that created this file. */
176   unsigned char version;
177
178   /* Some flag bits to keep track of various internal things. */
179   unsigned int flags;
180
181   /* Number of info entries.  */
182   size_t heapsize;
183
184   /* Pointer to first block of the heap (base of the first block).  */
185   void *heapbase;
186
187   /* Current search index for the heap table.  */
188   /* Search index in the info table.  */
189   size_t heapindex;
190
191   /* Limit of valid info table indices.  */
192   size_t heaplimit;
193
194   /* Block information table.
195      Allocated with malign/mfree (not mmalloc/mfree).  */
196   /* Table indexed by block number giving per-block information.  */
197   malloc_info *heapinfo;
198
199   /* List of all blocks containing free fragments of this size. The array indice is the log2 of requested size */
200   struct list fraghead[BLOCKLOG];
201
202   /* The base address of the memory region for this malloc heap.  This
203      is the location where the bookkeeping data for mmap and for malloc
204      begins. */
205
206   void *base;
207
208   /* The current location in the memory region for this malloc heap which
209      represents the end of memory in use. */
210
211   void *breakval;
212
213   /* The end of the current memory region for this malloc heap.  This is
214      the first location past the end of mapped memory. */
215
216   void *top;
217
218   /* Open file descriptor for the file to which this malloc heap is mapped.
219      This will always be a valid file descriptor, since /dev/zero is used
220      by default if no open file is supplied by the client.  Also note that
221      it may change each time the region is mapped and unmapped. */
222
223   int fd;
224
225 };
226
227 int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2, void* s_heap);
228
229 void mmalloc_display_info(void *h);
230
231 void *get_end_addr_heap(void *s_heap);
232
233 /* Bits to look at in the malloc descriptor flags word */
234
235 #define MMALLOC_DEVZERO         (1 << 0)        /* Have mapped to /dev/zero */
236 #define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
237 #define MMALLOC_INITIALIZED     (1 << 2)        /* Initialized mmalloc */
238
239 /* A default malloc descriptor for the single sbrk() managed region. */
240
241 extern struct mdesc *__mmalloc_default_mdp;
242
243 /* Remap a mmalloc region that was previously mapped. */
244
245 extern void *__mmalloc_remap_core(xbt_mheap_t mdp);
246
247 /*  Get core for the memory region specified by MDP, using SIZE as the
248     amount to either add to or subtract from the existing region.  Works
249     like sbrk(), but using mmap(). */
250 extern void *mmorecore(struct mdesc *mdp, int size);
251
252 /* Thread-safety (if the sem is already created)
253  *
254  * This is mandatory in the case where the user runs a parallel simulation
255  * in a model-checking enabled tree. Without this protection, our malloc
256  * implementation will not like multi-threading AT ALL.
257  */
258 #define LOCK(mdp) sem_wait(&mdp->sem)
259 #define UNLOCK(mdp) sem_post(&mdp->sem)
260
261 #endif                          /* __MMPRIVATE_H */