README: extra "from"
[cdsspec-compiler.git] / mymemory.cc
index 759bdccd89231eff77305f392166162d8c714de4..9e05c369235dadb077b6d09b1cfb7b2ece92180f 100644 (file)
@@ -1,13 +1,19 @@
-#include "mymemory.h"
-#include "snapshot.h"
-#include "snapshotimp.h"
+#include <stdlib.h>
 #include <stdio.h>
 #include <dlfcn.h>
 #include <unistd.h>
-#include <cstring>
+#include <string.h>
+#include <new>
+
+#include "mymemory.h"
+#include "snapshot.h"
 #include "common.h"
+#include "threads-model.h"
+#include "model.h"
+
 #define REQUESTS_BEFORE_ALLOC 1024
-size_t allocatedReqs[ REQUESTS_BEFORE_ALLOC ] = { 0 };
+
+size_t allocatedReqs[REQUESTS_BEFORE_ALLOC] = { 0 };
 int nextRequest = 0;
 int howManyFreed = 0;
 #if !USE_MPROTECT_SNAPSHOT
@@ -33,11 +39,8 @@ void *model_calloc(size_t count, size_t size)
        ptr = callocp(count, size);
        return ptr;
 #else
-       if (!snapshotrecord) {
-               createSharedMemory();
-       }
-       if (NULL == sStaticSpace)
-               sStaticSpace = create_mspace_with_base(( void *)( snapshotrecord->mSharedMemoryBase), SHARED_MEMORY_DEFAULT -sizeof(struct SnapShot), 1);
+       if (!sStaticSpace)
+               sStaticSpace = create_shared_mspace();
        return mspace_calloc(sStaticSpace, count, size);
 #endif
 }
@@ -61,11 +64,8 @@ void *model_malloc(size_t size)
        ptr = mallocp(size);
        return ptr;
 #else
-       if (!snapshotrecord) {
-               createSharedMemory();
-       }
-       if (NULL == sStaticSpace)
-               sStaticSpace = create_mspace_with_base(( void *)( snapshotrecord->mSharedMemoryBase), SHARED_MEMORY_DEFAULT -sizeof(struct SnapShot), 1);
+       if (!sStaticSpace)
+               sStaticSpace = create_shared_mspace();
        return mspace_malloc(sStaticSpace, size);
 #endif
 }
@@ -73,37 +73,31 @@ void *model_malloc(size_t size)
 /** @brief Snapshotting malloc, for use by model-checker (not user progs) */
 void * snapshot_malloc(size_t size)
 {
-       return malloc(size);
+       void *tmp = mspace_malloc(model_snapshot_space, size);
+       ASSERT(tmp);
+       return tmp;
 }
 
 /** @brief Snapshotting calloc, for use by model-checker (not user progs) */
 void * snapshot_calloc(size_t count, size_t size)
 {
-       return calloc(count, size);
+       void *tmp = mspace_calloc(model_snapshot_space, count, size);
+       ASSERT(tmp);
+       return tmp;
 }
 
-/** @brief Snapshotting free, for use by model-checker (not user progs) */
-void snapshot_free(void *ptr)
+/** @brief Snapshotting realloc, for use by model-checker (not user progs) */
+void *snapshot_realloc(void *ptr, size_t size)
 {
-       free(ptr);
+       void *tmp = mspace_realloc(model_snapshot_space, ptr, size);
+       ASSERT(tmp);
+       return tmp;
 }
 
-void *system_malloc(size_t size)
+/** @brief Snapshotting free, for use by model-checker (not user progs) */
+void snapshot_free(void *ptr)
 {
-       static void *(*mallocp)(size_t size);
-       char *error;
-       void *ptr;
-
-       /* get address of libc malloc */
-       if (!mallocp) {
-               mallocp = (void * (*)(size_t))dlsym(RTLD_NEXT, "malloc");
-               if ((error = dlerror()) != NULL) {
-                       fputs(error, stderr);
-                       exit(EXIT_FAILURE);
-               }
-       }
-       ptr = mallocp(size);
-       return ptr;
+       mspace_free(model_snapshot_space, ptr);
 }
 
 /** Non-snapshotting free for our use. */
@@ -115,7 +109,7 @@ void model_free(void *ptr)
 
        /* get address of libc free */
        if (!freep) {
-               freep = ( void  ( * )( void *))dlsym(RTLD_NEXT, "free");
+               freep = (void (*)(void *))dlsym(RTLD_NEXT, "free");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
                        exit(EXIT_FAILURE);
@@ -127,12 +121,8 @@ void model_free(void *ptr)
 #endif
 }
 
-/** @brief Global mspace reference for the snapshotting heap */
-mspace mySpace = NULL;
-
-/** Bootstrap allocation.  Problem is that the dynamic linker calls
- *  require calloc to work and calloc requires the dynamic linker to
- *     work.  */
+/** Bootstrap allocation. Problem is that the dynamic linker calls require
+ *  calloc to work and calloc requires the dynamic linker to work. */
 
 #define BOOTSTRAPBYTES 4096
 char bootstrapmemory[BOOTSTRAPBYTES];
@@ -144,28 +134,54 @@ void * HandleEarlyAllocationRequest(size_t sz)
        sz = (sz + 7) & ~7;
 
        if (sz > (BOOTSTRAPBYTES-offset)) {
-               printf("OUT OF BOOTSTRAP MEMORY\n");
+               model_print("OUT OF BOOTSTRAP MEMORY\n");
                exit(EXIT_FAILURE);
        }
 
-       void *pointer= (void *)&bootstrapmemory[offset];
+       void *pointer = (void *)&bootstrapmemory[offset];
        offset += sz;
        return pointer;
 }
 
+/** @brief Global mspace reference for the model-checker's snapshotting heap */
+mspace model_snapshot_space = NULL;
+
+#if USE_MPROTECT_SNAPSHOT
+
+/** @brief Global mspace reference for the user's snapshotting heap */
+mspace user_snapshot_space = NULL;
+
 /** Check whether this is bootstrapped memory that we should not free */
 static bool DontFree(void *ptr)
 {
        return (ptr >= (&bootstrapmemory[0]) && ptr < (&bootstrapmemory[BOOTSTRAPBYTES]));
 }
 
-/** @brief Snapshotting malloc implementation for user programs */
+/**
+ * @brief The allocator function for "user" allocation
+ *
+ * Should only be used for allocations which will not disturb the allocation
+ * patterns of a user thread.
+ */
+static void * user_malloc(size_t size)
+{
+       void *tmp = mspace_malloc(user_snapshot_space, size);
+       ASSERT(tmp);
+       return tmp;
+}
+
+/**
+ * @brief Snapshotting malloc implementation for user programs
+ *
+ * Do NOT call this function from a model-checker context. Doing so may disrupt
+ * the allocation patterns of a user thread.
+ */
 void *malloc(size_t size)
 {
-       if (mySpace) {
-               void *tmp = mspace_malloc(mySpace, size);
-               ASSERT(tmp);
-               return tmp;
+       if (user_snapshot_space) {
+               /* Only perform user allocations from user context */
+               ASSERT(!model || thread_current());
+               return user_malloc(size);
        } else
                return HandleEarlyAllocationRequest(size);
 }
@@ -174,13 +190,13 @@ void *malloc(size_t size)
 void free(void * ptr)
 {
        if (!DontFree(ptr))
-               mspace_free(mySpace, ptr);
+               mspace_free(user_snapshot_space, ptr);
 }
 
 /** @brief Snapshotting realloc implementation for user programs */
 void *realloc(void *ptr, size_t size)
 {
-       void *tmp = mspace_realloc(mySpace, ptr, size);
+       void *tmp = mspace_realloc(user_snapshot_space, ptr, size);
        ASSERT(tmp);
        return tmp;
 }
@@ -188,17 +204,29 @@ void *realloc(void *ptr, size_t size)
 /** @brief Snapshotting calloc implementation for user programs */
 void * calloc(size_t num, size_t size)
 {
-       if (mySpace) {
-               void *tmp = mspace_calloc(mySpace, num, size);
+       if (user_snapshot_space) {
+               void *tmp = mspace_calloc(user_snapshot_space, num, size);
                ASSERT(tmp);
                return tmp;
        } else {
                void *tmp = HandleEarlyAllocationRequest(size * num);
-               std::memset(tmp, 0, size * num);
+               memset(tmp, 0, size * num);
                return tmp;
        }
 }
 
+/** @brief Snapshotting allocation function for use by the Thread class only */
+void * Thread_malloc(size_t size)
+{
+       return user_malloc(size);
+}
+
+/** @brief Snapshotting free function for use by the Thread class only */
+void Thread_free(void *ptr)
+{
+       free(ptr);
+}
+
 /** @brief Snapshotting new operator for user programs */
 void * operator new(size_t size) throw(std::bad_alloc)
 {
@@ -222,3 +250,19 @@ void operator delete[](void *p, size_t size)
 {
        free(p);
 }
+
+#else /* !USE_MPROTECT_SNAPSHOT */
+
+/** @brief Snapshotting allocation function for use by the Thread class only */
+void * Thread_malloc(size_t size)
+{
+       return malloc(size);
+}
+
+/** @brief Snapshotting free function for use by the Thread class only */
+void Thread_free(void *ptr)
+{
+       free(ptr);
+}
+
+#endif /* !USE_MPROTECT_SNAPSHOT */