Logo AND Algorithmique Numérique Distribuée

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