Logo AND Algorithmique Numérique Distribuée

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