Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
various cosmetics and comments improvements
[simgrid.git] / src / xbt / mmalloc / mmprivate.h
index 55908d2..4171788 100644 (file)
 #ifndef __MMPRIVATE_H
 #define __MMPRIVATE_H 1
 
+#include "portable.h"
 #include "xbt/xbt_os_thread.h"
 #include "xbt/mmalloc.h"
+#include <semaphore.h>
 
 #ifdef HAVE_LIMITS_H
 #  include <limits.h>
 #  endif
 #endif
 
-#ifndef MIN
-#  define MIN(A, B) ((A) < (B) ? (A) : (B))
-#endif
-
-#define MMALLOC_MAGIC          "mmalloc"       /* Mapped file magic number */
-#define MMALLOC_MAGIC_SIZE     8               /* Size of magic number buf */
-#define MMALLOC_VERSION                1               /* Current mmalloc version */
-#define MMALLOC_KEYS           16              /* Keys for application use */
+#define MMALLOC_MAGIC          "mmalloc"       /* Mapped file magic number */
+#define MMALLOC_MAGIC_SIZE     8       /* Size of magic number buf */
+#define MMALLOC_VERSION                1       /* Current mmalloc version */
 
 /* The allocator divides the heap into blocks of fixed size; large
    requests receive one or more whole blocks, and small requests
 
 #define ADDRESS(B) ((void*) (((ADDR2UINT(B)) - 1) * BLOCKSIZE + (char*) mdp -> heapbase))
 
-/* Thread-safety (if the mutex is already created)*/
-#define LOCK(mdp) if (mdp->mutex) xbt_os_mutex_acquire(mdp->mutex)
-#define UNLOCK(mdp) if (mdp->mutex) xbt_os_mutex_release(mdp->mutex)
 const char *xbt_thread_self_name(void);
 
 /* Data structure giving per-block information.  */
-typedef union
-  {
-    /* Heap information for a busy block.  */
-    struct
-      {
-       /* Zero for a large block, or positive giving the
-          logarithm to the base two of the fragment size.  */
-       int type;
-       union
-         {
-           struct
-             {
-               size_t nfree;   /* Free fragments in a fragmented block.  */
-               size_t first;   /* First free fragment of the block.  */
-             } frag;
-           /* Size (in blocks) of a large cluster.  */
-           size_t size;
-         } info;
-      } busy;
-    /* Heap information for a free block (that may be the first of
-       a free cluster).  */
-    struct
-      {
-       size_t size;            /* Size (in blocks) of a free cluster.  */
-       size_t next;            /* Index of next free cluster.  */
-       size_t prev;            /* Index of previous free cluster.  */
-      } free;
-  } malloc_info;
+typedef union {
+  /* Heap information for a busy block.  */
+  struct {
+    /* Zero for a large block, or positive giving the
+       logarithm to the base two of the fragment size.  */
+    int type;
+    union {
+      struct {
+        size_t nfree;           /* Free fragments in a fragmented block.  */
+        size_t first;           /* First free fragment of the block.  */
+      } frag;
+      struct {
+       size_t size; /* Size (in blocks) of a large cluster.  */
+       size_t busy_size; 
+      } block;
+    } info;
+  } busy;
+  /* Heap information for a free block (that may be the first of
+     a free cluster).  */
+  struct {
+    size_t size;                /* Size (in blocks) of a free cluster.  */
+    size_t next;                /* Index of next free cluster.  */
+    size_t prev;                /* Index of previous free cluster.  */
+  } free;
+} malloc_info;
 
 /* List of blocks allocated with `mmemalign' (or `mvalloc').  */
 
-struct alignlist
-  {
-    struct alignlist *next;
-    void* aligned;             /* The address that mmemaligned returned.  */
-    void* exact;                       /* The address that malloc returned.  */
-  };
+struct alignlist {
+  struct alignlist *next;
+  void *aligned;                /* The address that mmemaligned returned.  */
+  void *exact;                  /* The address that malloc returned.  */
+};
 
 /* Doubly linked lists of free fragments.  */
-
-struct list
-  {
-    struct list *next;
-    struct list *prev;
-  };
-
-/* Statistics available to the user.
-   FIXME:  By design, the internals of the malloc package are no longer
-   exported to the user via an include file, so access to this data needs
-   to be via some other mechanism, such as mmstat_<something> where the
-   return value is the <something> the user is interested in. */
-
-struct mstats
-  {
-    size_t bytes_total;                /* Total size of the heap. */
-    size_t chunks_used;                /* Chunks allocated by the user. */
-    size_t bytes_used;         /* Byte total of user-allocated chunks. */
-    size_t chunks_free;                /* Chunks in the free list. */
-    size_t bytes_free;         /* Byte total of chunks in the free list. */
-  };
+struct list {
+  struct list *next;
+  struct list *prev;
+};
 
 /* Internal structure that defines the format of the malloc-descriptor.
    This gets written to the base address of the region that mmalloc is
@@ -150,7 +123,16 @@ struct mstats
    if such a file exists. */
 
 struct mdesc {
-  xbt_os_mutex_t mutex;
+
+  /* Semaphore locking the access to the heap */
+  sem_t sem;
+
+  /* Number of processes that attached the heap */
+  unsigned int refcount;
+
+  /* Chained lists of mdescs */
+  struct mdesc *next_mdesc;
+  
   /* The "magic number" for an mmalloc file. */
   char magic[MMALLOC_MAGIC_SIZE];
 
@@ -164,52 +146,11 @@ struct mdesc {
   /* Some flag bits to keep track of various internal things. */
   unsigned int flags;
 
-  /* If a system call made by the mmalloc package fails, the errno is
-     preserved for future examination. */
-  int saved_errno;
-
-  /* Pointer to the function that is used to get more core, or return core
-     to the system, for requests using this malloc descriptor.  For memory
-     mapped regions, this is the mmap() based routine.  There may also be
-     a single malloc descriptor that points to an sbrk() based routine
-     for systems without mmap() or for applications that call the mmalloc()
-     package with a NULL malloc descriptor.
-
-     FIXME:  For mapped regions shared by more than one process, this
-     needs to be maintained on a per-process basis. */
-  void* (*morecore) (struct mdesc *mdp, int size);
-     
-  /* Pointer to the function that causes an abort when the memory checking
-     features are activated.  By default this is set to abort(), but can
-     be set to another function by the application using mmalloc().
-
-     FIXME:  For mapped regions shared by more than one process, this
-     needs to be maintained on a per-process basis. */
-  void (*abortfunc) (void);
-
-  /* Debugging hook for free.
-
-     FIXME:  For mapped regions shared by more than one process, this
-     needs to be maintained on a per-process basis. */
-  void (*mfree_hook) (void* mdp, void* ptr);
-
-  /* Debugging hook for `malloc'.
-
-     FIXME:  For mapped regions shared by more than one process, this
-     needs to be maintained on a per-process basis. */
-  void* (*mmalloc_hook) (void* mdp, size_t size);
-
-  /* Debugging hook for realloc.
-
-     FIXME:  For mapped regions shared by more than one process, this
-     needs to be maintained on a per-process basis. */
-  void* (*mrealloc_hook) (void* mdp, void* ptr, size_t size);
-
   /* Number of info entries.  */
   size_t heapsize;
 
   /* Pointer to first block of the heap (base of the first block).  */
-  voidheapbase;
+  void *heapbase;
 
   /* Current search index for the heap table.  */
   /* Search index in the info table.  */
@@ -224,10 +165,6 @@ struct mdesc {
 
   malloc_info *heapinfo;
 
-  /* Instrumentation.  */
-
-  struct mstats heapstats;
-
   /* Free list headers for each fragment size.  */
   /* Free lists for each fragment size.  */
 
@@ -241,17 +178,17 @@ struct mdesc {
      is the location where the bookkeeping data for mmap and for malloc
      begins. */
 
-  voidbase;
+  void *base;
 
   /* The current location in the memory region for this malloc heap which
      represents the end of memory in use. */
 
-  voidbreakval;
+  void *breakval;
 
   /* The end of the current memory region for this malloc heap.  This is
      the first location past the end of mapped memory. */
 
-  voidtop;
+  void *top;
 
   /* Open file descriptor for the file to which this malloc heap is mapped.
      This will always be a valid file descriptor, since /dev/zero is used
@@ -260,52 +197,40 @@ struct mdesc {
 
   int fd;
 
-  /* An array of keys to data within the mapped region, for use by the
-     application.  */
+};
 
-  void* keys[MMALLOC_KEYS];
+int mmalloc_compare_mdesc(struct mdesc *mdp1, struct mdesc *mdp2, void *std_heap_addr);
 
-};
+void mmalloc_display_info(void *h);
 
 /* Bits to look at in the malloc descriptor flags word */
 
-#define MMALLOC_DEVZERO                (1 << 0)        /* Have mapped to /dev/zero */
-#define MMALLOC_ANONYMOUS (1 << 1)  /* Use anonymous mapping */
-#define MMALLOC_INITIALIZED    (1 << 2)        /* Initialized mmalloc */
-#define MMALLOC_MMCHECK_USED   (1 << 3)        /* mmcheckf() called already */
+#define MMALLOC_DEVZERO                (1 << 0)        /* Have mapped to /dev/zero */
+#define MMALLOC_ANONYMOUS (1 << 1)      /* Use anonymous mapping */
+#define MMALLOC_INITIALIZED    (1 << 2)        /* Initialized mmalloc */
 
 /* Internal version of `mfree' used in `morecore'. */
 
-extern void __mmalloc_free (struct mdesc *mdp, void* ptr);
+extern void __mmalloc_free(struct mdesc *mdp, void *ptr);
 
 /* A default malloc descriptor for the single sbrk() managed region. */
 
 extern struct mdesc *__mmalloc_default_mdp;
 
-/* Initialize the first use of the default malloc descriptor, which uses
-   an sbrk() region. */
-
-extern struct mdesc *__mmalloc_create_default_mdp (void);
-
-/* Grow or shrink a contiguous mapped region using mmap().
-   Works much like sbrk(), only faster */
-
-extern void* __mmalloc_mmap_morecore (struct mdesc *mdp, int size);
-
-
 /* Remap a mmalloc region that was previously mapped. */
 
-extern void* __mmalloc_remap_core (struct mdesc *mdp);
+extern void *__mmalloc_remap_core(xbt_mheap_t mdp);
+
+/*  Get core for the memory region specified by MDP, using SIZE as the
+    amount to either add to or subtract from the existing region.  Works
+    like sbrk(), but using mmap(). */
+extern void *mmorecore(struct mdesc *mdp, int size);
 
-/* Macro to convert from a user supplied malloc descriptor to pointer to the
-   internal malloc descriptor.  If the user supplied descriptor is NULL, then
-   use the default internal version, initializing it if necessary.  Otherwise
-   just cast the user supplied version (which is void *) to the proper type
-   (struct mdesc *). */
+/* Thread-safety (if the sem is already created) FIXME: KILLIT*/
+#define LOCK(mdp)                                        \
+  sem_wait(&mdp->sem)
 
-#define MD_TO_MDP(md) \
-  ((md) == NULL \
-   ? __mmalloc_default_mdp  \
-   : (struct mdesc *) (md))
+#define UNLOCK(mdp)                                        \
+    sem_post(&mdp->sem)
 
-#endif  /* __MMPRIVATE_H */
+#endif                          /* __MMPRIVATE_H */