README: extra "from"
[cdsspec-compiler.git] / mymemory.cc
index f3464fc6bff4927e6f1b36d5678b062a1b87519b..9e05c369235dadb077b6d09b1cfb7b2ece92180f 100644 (file)
@@ -1,54 +1,61 @@
-#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
 static mspace sStaticSpace = NULL;
 #endif
 
-/** Non-snapshotting malloc for our use. */
-
-void *MYMALLOC(size_t size) {
+/** Non-snapshotting calloc for our use. */
+void *model_calloc(size_t count, size_t size)
+{
 #if USE_MPROTECT_SNAPSHOT
-       static void *(*mallocp)(size_t size);
+       static void *(*callocp)(size_t count, size_t size) = NULL;
        char *error;
        void *ptr;
 
        /* get address of libc malloc */
-       if (!mallocp) {
-               mallocp = ( void * ( * )( size_t ) )dlsym(RTLD_NEXT, "malloc");
+       if (!callocp) {
+               callocp = (void * (*)(size_t, size_t))dlsym(RTLD_NEXT, "calloc");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
                        exit(EXIT_FAILURE);
                }
        }
-       ptr = mallocp(size);
+       ptr = callocp(count, size);
        return ptr;
 #else
-       if( !sTheRecord ){
-               createSharedLibrary();
-       }
-       if( NULL == sStaticSpace )
-               sStaticSpace = create_mspace_with_base( ( void * )( sTheRecord->mSharedMemoryBase ), SHARED_MEMORY_DEFAULT -sizeof( struct Snapshot ), 1 );
-       return mspace_malloc( sStaticSpace, size );
+       if (!sStaticSpace)
+               sStaticSpace = create_shared_mspace();
+       return mspace_calloc(sStaticSpace, count, size);
 #endif
 }
 
-void *system_malloc( size_t size ){
-       static void *(*mallocp)(size_t size);
+/** Non-snapshotting malloc for our use. */
+void *model_malloc(size_t size)
+{
+#if USE_MPROTECT_SNAPSHOT
+       static void *(*mallocp)(size_t size) = NULL;
        char *error;
        void *ptr;
 
        /* get address of libc malloc */
        if (!mallocp) {
-               mallocp = ( void * ( * )( size_t ) )dlsym(RTLD_NEXT, "malloc");
+               mallocp = (void * (*)(size_t))dlsym(RTLD_NEXT, "malloc");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
                        exit(EXIT_FAILURE);
@@ -56,32 +63,53 @@ void *system_malloc( size_t size ){
        }
        ptr = mallocp(size);
        return ptr;
+#else
+       if (!sStaticSpace)
+               sStaticSpace = create_shared_mspace();
+       return mspace_malloc(sStaticSpace, size);
+#endif
 }
 
-void system_free( void * ptr ){
-       static void (*freep)(void *);
-       char *error;
+/** @brief Snapshotting malloc, for use by model-checker (not user progs) */
+void * snapshot_malloc(size_t size)
+{
+       void *tmp = mspace_malloc(model_snapshot_space, size);
+       ASSERT(tmp);
+       return tmp;
+}
 
-       /* get address of libc free */
-       if (!freep) {
-               freep = ( void  ( * )( void * ) )dlsym(RTLD_NEXT, "free");
-               if ((error = dlerror()) != NULL) {
-                       fputs(error, stderr);
-                       exit(EXIT_FAILURE);
-               }
-       }
-       freep(ptr);
+/** @brief Snapshotting calloc, for use by model-checker (not user progs) */
+void * snapshot_calloc(size_t count, size_t size)
+{
+       void *tmp = mspace_calloc(model_snapshot_space, count, size);
+       ASSERT(tmp);
+       return tmp;
+}
+
+/** @brief Snapshotting realloc, for use by model-checker (not user progs) */
+void *snapshot_realloc(void *ptr, size_t size)
+{
+       void *tmp = mspace_realloc(model_snapshot_space, ptr, size);
+       ASSERT(tmp);
+       return tmp;
+}
+
+/** @brief Snapshotting free, for use by model-checker (not user progs) */
+void snapshot_free(void *ptr)
+{
+       mspace_free(model_snapshot_space, ptr);
 }
 
 /** Non-snapshotting free for our use. */
-void MYFREE(void *ptr) {
+void model_free(void *ptr)
+{
 #if USE_MPROTECT_SNAPSHOT
        static void (*freep)(void *);
        char *error;
 
        /* 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);
@@ -89,98 +117,152 @@ void MYFREE(void *ptr) {
        }
        freep(ptr);
 #else
-       mspace_free( sStaticSpace, ptr );
+       mspace_free(sStaticSpace, ptr);
 #endif
 }
 
+/** Bootstrap allocation. Problem is that the dynamic linker calls require
+ *  calloc to work and calloc requires the dynamic linker to work. */
 
-/** This global references the mspace for the snapshotting heap */
-mspace mySpace = NULL;
-
-/** This global references the unaligned memory address that was malloced for the snapshotting heap */
-void * basemySpace = NULL;
+#define BOOTSTRAPBYTES 4096
+char bootstrapmemory[BOOTSTRAPBYTES];
+size_t offset = 0;
 
-/** Adding the fix for not able to allocate through a reimplemented calloc at the beginning before instantiating our allocator
-A bit circumspect about adding an sbrk. linux docs say to avoid using it... */
+void * HandleEarlyAllocationRequest(size_t sz)
+{
+       /* Align to 8 byte boundary */
+       sz = (sz + 7) & ~7;
 
-void * HandleEarlyAllocationRequest( size_t sz ){
-       if( 0 == mySpace ){
-               void * returnAddress = sbrk( sz );
-               if( nextRequest >= REQUESTS_BEFORE_ALLOC ){
-                       exit( EXIT_FAILURE );
-               }
-               allocatedReqs[ nextRequest++ ] = ( size_t )returnAddress;
-               return returnAddress;
+       if (sz > (BOOTSTRAPBYTES-offset)) {
+               model_print("OUT OF BOOTSTRAP MEMORY\n");
+               exit(EXIT_FAILURE);
        }
-       return NULL;
+
+       void *pointer = (void *)&bootstrapmemory[offset];
+       offset += sz;
+       return pointer;
 }
 
-/** The fact that I am not expecting more than a handful requests is implicit in my not using a binary search here*/
+/** @brief Global mspace reference for the model-checker's snapshotting heap */
+mspace model_snapshot_space = NULL;
 
-bool DontFree( void * ptr ){
-       if( howManyFreed == nextRequest ) return false; //a minor optimization to reduce the number of instructions executed on each free call....
-       if( NULL == ptr ) return true;
-       for( int i =  nextRequest - 1; i >= 0; --i ){
-               if( allocatedReqs[ i ] ==  ( size_t )ptr ) {
-                       ++howManyFreed;
-                       return true;
-               }
-       }
-       return false;
-}
+#if USE_MPROTECT_SNAPSHOT
 
-/** Snapshotting malloc implementation for user programs. */
+/** @brief Global mspace reference for the user's snapshotting heap */
+mspace user_snapshot_space = NULL;
 
-void *malloc( size_t size ) {
-       void * earlyReq = HandleEarlyAllocationRequest( size );
-       if( earlyReq ) return earlyReq;
-       return mspace_malloc( mySpace, size );
+/** Check whether this is bootstrapped memory that we should not free */
+static bool DontFree(void *ptr)
+{
+       return (ptr >= (&bootstrapmemory[0]) && ptr < (&bootstrapmemory[BOOTSTRAPBYTES]));
 }
 
-/** Snapshotting free implementation for user programs. */
-
-void free( void * ptr ){
-       if( DontFree( ptr ) ) return;
-       mspace_free( mySpace, ptr );
+/**
+ * @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;
 }
 
-/** Snapshotting realloc implementation for user programs. */
+/**
+ * @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 (user_snapshot_space) {
+               /* Only perform user allocations from user context */
+               ASSERT(!model || thread_current());
+               return user_malloc(size);
+       } else
+               return HandleEarlyAllocationRequest(size);
+}
 
-void *realloc( void *ptr, size_t size ){
-       return mspace_realloc( mySpace, ptr, size );
+/** @brief Snapshotting free implementation for user programs */
+void free(void * ptr)
+{
+       if (!DontFree(ptr))
+               mspace_free(user_snapshot_space, ptr);
 }
 
-/** Snapshotting calloc implementation for user programs. */
+/** @brief Snapshotting realloc implementation for user programs */
+void *realloc(void *ptr, size_t size)
+{
+       void *tmp = mspace_realloc(user_snapshot_space, ptr, size);
+       ASSERT(tmp);
+       return tmp;
+}
 
-void * calloc( size_t num, size_t size ){
-       void * earlyReq = HandleEarlyAllocationRequest( size * num );
-       if( earlyReq ) {
-               std::memset( earlyReq, 0, size * num );
-               return earlyReq;
+/** @brief Snapshotting calloc implementation for user programs */
+void * calloc(size_t num, size_t size)
+{
+       if (user_snapshot_space) {
+               void *tmp = mspace_calloc(user_snapshot_space, num, size);
+               ASSERT(tmp);
+               return tmp;
+       } else {
+               void *tmp = HandleEarlyAllocationRequest(size * num);
+               memset(tmp, 0, size * num);
+               return tmp;
        }
-       return mspace_calloc( mySpace, num, size );
 }
 
-/** Snapshotting new operator for user programs. */
+/** @brief Snapshotting allocation function for use by the Thread class only */
+void * Thread_malloc(size_t size)
+{
+       return user_malloc(size);
+}
 
-void * operator new(size_t size) throw(std::bad_alloc) {
+/** @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)
+{
        return malloc(size);
 }
 
-/** Snapshotting delete operator for user programs. */
+/** @brief Snapshotting delete operator for user programs */
+void operator delete(void *p) throw()
+{
+       free(p);
+}
 
-void operator delete(void *p) throw() {
+/** @brief Snapshotting new[] operator for user programs */
+void * operator new[](size_t size) throw(std::bad_alloc)
+{
+       return malloc(size);
+}
+
+/** @brief Snapshotting delete[] operator for user programs */
+void operator delete[](void *p, size_t size)
+{
        free(p);
 }
 
-/** Snapshotting new[] operator for user programs. */
+#else /* !USE_MPROTECT_SNAPSHOT */
 
-void * operator new[](size_t size) throw(std::bad_alloc) {
+/** @brief Snapshotting allocation function for use by the Thread class only */
+void * Thread_malloc(size_t size)
+{
        return malloc(size);
 }
 
-/** Snapshotting delete[] operator for user programs. */
-
-void operator delete[](void *p, size_t size) {
-       free(p);
+/** @brief Snapshotting free function for use by the Thread class only */
+void Thread_free(void *ptr)
+{
+       free(ptr);
 }
+
+#endif /* !USE_MPROTECT_SNAPSHOT */