Logo AND Algorithmique Numérique Distribuée

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