Logo AND Algorithmique Numérique Distribuée

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