Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
dcf8c4ecd376c821d912a6a3adb0c4caeea2c112
[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 #define MIN(a, b) ((a) < (b) ? (a) : (b))
30 #define MAX(a, b) ((a) > (b) ? (a) : (b))
31
32 #ifdef HAVE_LIMITS_H
33 #  include <limits.h>
34 #else
35 #  ifndef CHAR_BIT
36 #    define CHAR_BIT 8
37 #  endif
38 #endif
39
40 #define MMALLOC_MAGIC    "mmalloc"       /* Mapped file magic number */
41 #define MMALLOC_MAGIC_SIZE  8       /* Size of magic number buf */
42 #define MMALLOC_VERSION    2       /* Current mmalloc version */
43
44 /* The allocator divides the heap into blocks of fixed size; large
45    requests receive one or more whole blocks, and small requests
46    receive a fragment of a block.  Fragment sizes are powers of two,
47    and all fragments of a block are the same size.  When all the
48    fragments in a block have been freed, the block itself is freed.
49
50    FIXME: we are not targeting 16bits machines anymore; update values */
51
52 #define INT_BIT    (CHAR_BIT * sizeof(int))
53 #define BLOCKLOG  (INT_BIT > 16 ? 12 : 9)
54 #define BLOCKSIZE  ((unsigned int) 1 << BLOCKLOG)
55 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
56
57 /* We keep fragment-specific meta-data for introspection purposes, and these
58  * information are kept in fixed lenght arrays. Here is the computation of
59  * that size.
60  *
61  * Never make SMALLEST_POSSIBLE_MALLOC smaller than sizeof(list) because we
62  * need to enlist the free fragments.
63  */
64
65 //#define SMALLEST_POSSIBLE_MALLOC (sizeof(struct list))
66 #define SMALLEST_POSSIBLE_MALLOC (16*sizeof(struct list))
67 #define MAX_FRAGMENT_PER_BLOCK (BLOCKSIZE / SMALLEST_POSSIBLE_MALLOC)
68
69 /* The difference between two pointers is a signed int.  On machines where
70    the data addresses have the high bit set, we need to ensure that the
71    difference becomes an unsigned int when we are using the address as an
72    integral value.  In addition, when using with the '%' operator, the
73    sign of the result is machine dependent for negative values, so force
74    it to be treated as an unsigned int. */
75
76 #define ADDR2UINT(addr)  ((uintptr_t) ((char*) (addr) - (char*) NULL))
77 #define RESIDUAL(addr,bsize) ((uintptr_t) (ADDR2UINT (addr) % (bsize)))
78
79 /* Determine the amount of memory spanned by the initial heap table
80    (not an absolute limit).  */
81
82 #define HEAP    (INT_BIT > 16 ? 4194304 : 65536)
83
84 /* Number of contiguous free blocks allowed to build up at the end of
85    memory before they will be returned to the system.
86    FIXME: this is not used anymore: we never return memory to the system. */
87 #define FINAL_FREE_BLOCKS  8
88
89 /* Where to start searching the free list when looking for new memory.
90    The two possible values are 0 and heapindex.  Starting at 0 seems
91    to reduce total memory usage, while starting at heapindex seems to
92    run faster.  */
93
94 #define MALLOC_SEARCH_START  mdp -> heapindex
95
96 /* Address to block number and vice versa.  */
97
98 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
99
100 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
101
102 SG_BEGIN_DECL()
103
104 /* Doubly linked lists of free fragments.  */
105 struct list {
106   struct list *next;
107   struct list *prev;
108 };
109
110 /* Statistics available to the user. */
111 struct mstats
112 {
113   size_t bytes_total;    /* Total size of the heap. */
114   size_t chunks_used;    /* Chunks allocated by the user. */
115   size_t bytes_used;    /* Byte total of user-allocated chunks. */
116   size_t chunks_free;    /* Chunks in the free list. */
117   size_t bytes_free;    /* Byte total of chunks in the free list. */
118 };
119
120 #define MMALLOC_TYPE_HEAPINFO (-2)
121 #define MMALLOC_TYPE_FREE (-1)
122 #define MMALLOC_TYPE_UNFRAGMENTED 0
123 /* >0 values are fragmented blocks */
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 /** @brief Descriptor of a mmalloc area
180  *
181  * Internal structure that defines the format of the malloc-descriptor.
182  * This gets written to the base address of the region that mmalloc is
183  * managing, and thus also becomes the file header for the mapped file,
184  * if such a file exists.
185  * */
186 struct mdesc {
187
188   /** @brief Mutex locking the access to the heap */
189   pthread_mutex_t mutex;
190
191   /** @brief Number of processes that attached the heap */
192   unsigned int refcount;
193
194   /** @brief Chained lists of mdescs */
195   struct mdesc *next_mdesc;
196
197   /** @brief The "magic number" for an mmalloc file. */
198   char magic[MMALLOC_MAGIC_SIZE];
199
200   /** @brief The size in bytes of this structure
201    *
202    * Used as a sanity check when reusing a previously created mapped file.
203    * */
204   unsigned int headersize;
205
206   /** @brief Version number of the mmalloc package that created this file. */
207   unsigned char version;
208
209   unsigned int options;
210
211   /** @brief Some flag bits to keep track of various internal things. */
212   unsigned int flags;
213
214   /** @brief Number of info entries.  */
215   size_t heapsize;
216
217   /** @brief Pointer to first block of the heap (base of the first block).  */
218   void *heapbase;
219
220   /** @brief Current search index for the heap table.
221    *
222    *  Search index in the info table.
223    */
224   size_t heapindex;
225
226   /** @brief Limit of valid info table indices.  */
227   size_t heaplimit;
228
229   /** @brief Block information table.
230    *
231    * Table indexed by block number giving per-block information.
232    */
233   malloc_info *heapinfo;
234
235   /* @brief List of all blocks containing free fragments of a given size.
236    *
237    * The array indice is the log2 of requested size.
238    * Actually only the sizes 8->11 seem to be used, but who cares? */
239   s_xbt_swag_t fraghead[BLOCKLOG];
240
241   /* @brief Base address of the memory region for this malloc heap
242    *
243    * This is the location where the bookkeeping data for mmap and
244    * for malloc begins.
245    */
246   void *base;
247
248   /** @brief End of memory in use
249    *
250    *  Some memory might be already mapped by the OS but not used
251    *  by the heap.
252    * */
253   void *breakval;
254
255   /** @brief End of the current memory region for this malloc heap.
256    *
257    *  This is the first location past the end of mapped memory.
258    *
259    *  Compared to breakval, this value is rounded to the next memory page.
260    */
261   void *top;
262
263   /** @brief Open file descriptor for the file to which this malloc heap is mapped
264    *
265    * If this value is negative, MAP_ANONYMOUS memory is used.
266    *
267    * Also note that it may change each time the region is mapped and unmapped. */
268   int fd;
269
270   /* @brief Instrumentation */
271   struct mstats heapstats;
272
273 };
274
275 /* Bits to look at in the malloc descriptor flags word */
276
277 #define MMALLOC_DEVZERO    (1 << 0)        /* Have mapped to /dev/zero */
278 #define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
279 #define MMALLOC_INITIALIZED  (1 << 2)        /* Initialized mmalloc */
280
281 /* A default malloc descriptor for the single sbrk() managed region. */
282
283 XBT_PUBLIC_DATA struct mdesc* __mmalloc_default_mdp;
284
285 /* Remap a mmalloc region that was previously mapped. */
286
287 XBT_PUBLIC void* __mmalloc_remap_core(xbt_mheap_t mdp);
288
289 XBT_PUBLIC void* mmorecore(struct mdesc* mdp, ssize_t size);
290
291 /** Thread-safety (if the mutex is already created)
292  *
293  * This is mandatory in the case where the user runs a parallel simulation
294  * in a model-checking enabled tree. Without this protection, our malloc
295  * implementation will not like multi-threading AT ALL.
296  */
297 #define LOCK(mdp) pthread_mutex_lock(&mdp->mutex)
298 #define UNLOCK(mdp) pthread_mutex_unlock(&mdp->mutex)
299
300 XBT_PRIVATE int malloc_use_mmalloc(void);
301
302 XBT_PRIVATE size_t mmalloc_get_bytes_used_remote(size_t heaplimit, const malloc_info* heapinfo);
303
304 SG_END_DECL()
305
306 #endif