Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
55908d212b79b2182317eac4a08905c8d3eb799e
[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 "xbt/xbt_os_thread.h"
17 #include "xbt/mmalloc.h"
18
19 #ifdef HAVE_LIMITS_H
20 #  include <limits.h>
21 #else
22 #  ifndef CHAR_BIT
23 #    define CHAR_BIT 8
24 #  endif
25 #endif
26
27 #ifndef MIN
28 #  define MIN(A, B) ((A) < (B) ? (A) : (B))
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         1               /* Current mmalloc version */
34 #define MMALLOC_KEYS            16              /* Keys for application use */
35
36 /* The allocator divides the heap into blocks of fixed size; large
37    requests receive one or more whole blocks, and small requests
38    receive a fragment of a block.  Fragment sizes are powers of two,
39    and all fragments of a block are the same size.  When all the
40    fragments in a block have been freed, the block itself is freed.  */
41
42 #define INT_BIT         (CHAR_BIT * sizeof(int))
43 #define BLOCKLOG        (INT_BIT > 16 ? 12 : 9)
44 #define BLOCKSIZE       ((unsigned int) 1 << BLOCKLOG)
45 #define BLOCKIFY(SIZE)  (((SIZE) + BLOCKSIZE - 1) / BLOCKSIZE)
46
47 /* The difference between two pointers is a signed int.  On machines where
48    the data addresses have the high bit set, we need to ensure that the
49    difference becomes an unsigned int when we are using the address as an
50    integral value.  In addition, when using with the '%' operator, the
51    sign of the result is machine dependent for negative values, so force
52    it to be treated as an unsigned int. */
53
54 #define ADDR2UINT(addr) ((unsigned int) ((char*) (addr) - (char*) NULL))
55 #define RESIDUAL(addr,bsize) ((unsigned int) (ADDR2UINT (addr) % (bsize)))
56
57 /* Determine the amount of memory spanned by the initial heap table
58    (not an absolute limit).  */
59
60 #define HEAP            (INT_BIT > 16 ? 4194304 : 65536)
61
62 /* Number of contiguous free blocks allowed to build up at the end of
63    memory before they will be returned to the system.  */
64
65 #define FINAL_FREE_BLOCKS       8
66
67 /* Where to start searching the free list when looking for new memory.
68    The two possible values are 0 and heapindex.  Starting at 0 seems
69    to reduce total memory usage, while starting at heapindex seems to
70    run faster.  */
71
72 #define MALLOC_SEARCH_START     mdp -> heapindex
73
74 /* Address to block number and vice versa.  */
75
76 #define BLOCK(A) (((char*) (A) - (char*) mdp -> heapbase) / BLOCKSIZE + 1)
77
78 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
79
80 /* Thread-safety (if the mutex is already created)*/
81 #define LOCK(mdp) if (mdp->mutex) xbt_os_mutex_acquire(mdp->mutex)
82 #define UNLOCK(mdp) if (mdp->mutex) xbt_os_mutex_release(mdp->mutex)
83 const char *xbt_thread_self_name(void);
84
85 /* Data structure giving per-block information.  */
86 typedef union
87   {
88     /* Heap information for a busy block.  */
89     struct
90       {
91         /* Zero for a large block, or positive giving the
92            logarithm to the base two of the fragment size.  */
93         int type;
94         union
95           {
96             struct
97               {
98                 size_t nfree;   /* Free fragments in a fragmented block.  */
99                 size_t first;   /* First free fragment of the block.  */
100               } frag;
101             /* Size (in blocks) of a large cluster.  */
102             size_t size;
103           } info;
104       } busy;
105     /* Heap information for a free block (that may be the first of
106        a free cluster).  */
107     struct
108       {
109         size_t size;            /* Size (in blocks) of a free cluster.  */
110         size_t next;            /* Index of next free cluster.  */
111         size_t prev;            /* Index of previous free cluster.  */
112       } free;
113   } malloc_info;
114
115 /* List of blocks allocated with `mmemalign' (or `mvalloc').  */
116
117 struct alignlist
118   {
119     struct alignlist *next;
120     void* aligned;              /* The address that mmemaligned returned.  */
121     void* exact;                        /* The address that malloc returned.  */
122   };
123
124 /* Doubly linked lists of free fragments.  */
125
126 struct list
127   {
128     struct list *next;
129     struct list *prev;
130   };
131
132 /* Statistics available to the user.
133    FIXME:  By design, the internals of the malloc package are no longer
134    exported to the user via an include file, so access to this data needs
135    to be via some other mechanism, such as mmstat_<something> where the
136    return value is the <something> the user is interested in. */
137
138 struct mstats
139   {
140     size_t bytes_total;         /* Total size of the heap. */
141     size_t chunks_used;         /* Chunks allocated by the user. */
142     size_t bytes_used;          /* Byte total of user-allocated chunks. */
143     size_t chunks_free;         /* Chunks in the free list. */
144     size_t bytes_free;          /* Byte total of chunks in the free list. */
145   };
146
147 /* Internal structure that defines the format of the malloc-descriptor.
148    This gets written to the base address of the region that mmalloc is
149    managing, and thus also becomes the file header for the mapped file,
150    if such a file exists. */
151
152 struct mdesc {
153   xbt_os_mutex_t mutex;
154   /* The "magic number" for an mmalloc file. */
155   char magic[MMALLOC_MAGIC_SIZE];
156
157   /* The size in bytes of this structure, used as a sanity check when reusing
158      a previously created mapped file. */
159   unsigned int headersize;
160
161   /* The version number of the mmalloc package that created this file. */
162   unsigned char version;
163
164   /* Some flag bits to keep track of various internal things. */
165   unsigned int flags;
166
167   /* If a system call made by the mmalloc package fails, the errno is
168      preserved for future examination. */
169   int saved_errno;
170
171   /* Pointer to the function that is used to get more core, or return core
172      to the system, for requests using this malloc descriptor.  For memory
173      mapped regions, this is the mmap() based routine.  There may also be
174      a single malloc descriptor that points to an sbrk() based routine
175      for systems without mmap() or for applications that call the mmalloc()
176      package with a NULL malloc descriptor.
177
178      FIXME:  For mapped regions shared by more than one process, this
179      needs to be maintained on a per-process basis. */
180   void* (*morecore) (struct mdesc *mdp, int size);
181      
182   /* Pointer to the function that causes an abort when the memory checking
183      features are activated.  By default this is set to abort(), but can
184      be set to another function by the application using mmalloc().
185
186      FIXME:  For mapped regions shared by more than one process, this
187      needs to be maintained on a per-process basis. */
188   void (*abortfunc) (void);
189
190   /* Debugging hook for free.
191
192      FIXME:  For mapped regions shared by more than one process, this
193      needs to be maintained on a per-process basis. */
194   void (*mfree_hook) (void* mdp, void* ptr);
195
196   /* Debugging hook for `malloc'.
197
198      FIXME:  For mapped regions shared by more than one process, this
199      needs to be maintained on a per-process basis. */
200   void* (*mmalloc_hook) (void* mdp, size_t size);
201
202   /* Debugging hook for realloc.
203
204      FIXME:  For mapped regions shared by more than one process, this
205      needs to be maintained on a per-process basis. */
206   void* (*mrealloc_hook) (void* mdp, void* ptr, size_t size);
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/__mmalloc_free (not mmalloc/mfree).  */
223   /* Table indexed by block number giving per-block information.  */
224
225   malloc_info *heapinfo;
226
227   /* Instrumentation.  */
228
229   struct mstats heapstats;
230
231   /* Free list headers for each fragment size.  */
232   /* Free lists for each fragment size.  */
233
234   struct list fraghead[BLOCKLOG];
235
236   /* List of blocks allocated by memalign.  */
237
238   struct alignlist *aligned_blocks;
239
240   /* The base address of the memory region for this malloc heap.  This
241      is the location where the bookkeeping data for mmap and for malloc
242      begins. */
243
244   void* base;
245
246   /* The current location in the memory region for this malloc heap which
247      represents the end of memory in use. */
248
249   void* breakval;
250
251   /* The end of the current memory region for this malloc heap.  This is
252      the first location past the end of mapped memory. */
253
254   void* top;
255
256   /* Open file descriptor for the file to which this malloc heap is mapped.
257      This will always be a valid file descriptor, since /dev/zero is used
258      by default if no open file is supplied by the client.  Also note that
259      it may change each time the region is mapped and unmapped. */
260
261   int fd;
262
263   /* An array of keys to data within the mapped region, for use by the
264      application.  */
265
266   void* keys[MMALLOC_KEYS];
267
268 };
269
270 /* Bits to look at in the malloc descriptor flags word */
271
272 #define MMALLOC_DEVZERO         (1 << 0)        /* Have mapped to /dev/zero */
273 #define MMALLOC_ANONYMOUS (1 << 1)  /* Use anonymous mapping */
274 #define MMALLOC_INITIALIZED     (1 << 2)        /* Initialized mmalloc */
275 #define MMALLOC_MMCHECK_USED    (1 << 3)        /* mmcheckf() called already */
276
277 /* Internal version of `mfree' used in `morecore'. */
278
279 extern void __mmalloc_free (struct mdesc *mdp, void* ptr);
280
281 /* A default malloc descriptor for the single sbrk() managed region. */
282
283 extern struct mdesc *__mmalloc_default_mdp;
284
285 /* Initialize the first use of the default malloc descriptor, which uses
286    an sbrk() region. */
287
288 extern struct mdesc *__mmalloc_create_default_mdp (void);
289
290 /* Grow or shrink a contiguous mapped region using mmap().
291    Works much like sbrk(), only faster */
292
293 extern void* __mmalloc_mmap_morecore (struct mdesc *mdp, int size);
294
295
296 /* Remap a mmalloc region that was previously mapped. */
297
298 extern void* __mmalloc_remap_core (struct mdesc *mdp);
299
300 /* Macro to convert from a user supplied malloc descriptor to pointer to the
301    internal malloc descriptor.  If the user supplied descriptor is NULL, then
302    use the default internal version, initializing it if necessary.  Otherwise
303    just cast the user supplied version (which is void *) to the proper type
304    (struct mdesc *). */
305
306 #define MD_TO_MDP(md) \
307   ((md) == NULL \
308    ? __mmalloc_default_mdp  \
309    : (struct mdesc *) (md))
310
311 #endif  /* __MMPRIVATE_H */