mymemory: implement snapshot_*() allocations on model-checker's heap
[c11tester.git] / mymemory.cc
index 2b9c44d516282e1041487c6d0d1a5f1a78a1f472..08bd4e437c897967830d5dc760d0d4f27f351b50 100644 (file)
@@ -3,46 +3,56 @@
 #include "snapshotimp.h"
 #include <stdio.h>
 #include <dlfcn.h>
+#include <unistd.h>
+#include <cstring>
+#include "common.h"
+#define REQUESTS_BEFORE_ALLOC 1024
+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 (!snapshotrecord) {
+               createSharedMemory();
        }
-       if( NULL == sStaticSpace )
-               sStaticSpace = create_mspace_with_base( ( void * )( sTheRecord->mSharedMemoryBase ), SHARED_MEMORY_DEFAULT -sizeof( struct Snapshot_t ), 1 );
-       return mspace_malloc( sStaticSpace, size );
+       if (NULL == sStaticSpace)
+               sStaticSpace = create_mspace_with_base(( void *)( snapshotrecord->mSharedMemoryBase), SHARED_MEMORY_DEFAULT -sizeof(struct SnapShot), 1);
+       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);
@@ -50,32 +60,56 @@ void *system_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);
+       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);
@@ -83,57 +117,110 @@ 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;
+#define BOOTSTRAPBYTES 4096
+char bootstrapmemory[BOOTSTRAPBYTES];
+size_t offset = 0;
 
-/** This global references the unaligned memory address that was malloced for the snapshotting heap */
-void * basemySpace = NULL;
+void * HandleEarlyAllocationRequest(size_t sz)
+{
+       /* Align to 8 byte boundary */
+       sz = (sz + 7) & ~7;
 
-//Subramanian --- please make these work for the fork based approach
-
-/** Snapshotting malloc implementation for user programs. */
+       if (sz > (BOOTSTRAPBYTES-offset)) {
+               printf("OUT OF BOOTSTRAP MEMORY\n");
+               exit(EXIT_FAILURE);
+       }
 
-void *malloc( size_t size ) {
-       return mspace_malloc( mySpace, size );
+       void *pointer= (void *)&bootstrapmemory[offset];
+       offset += sz;
+       return pointer;
 }
 
-/** Snapshotting free implementation for user programs. */
+/** @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
+ *  @todo use this ONLY for user's allocations, not for internal snapshotting
+ *  state */
+mspace user_snapshot_space = NULL;
 
-void free( void * ptr ){
-       mspace_free( mySpace, ptr );
+/** Check whether this is bootstrapped memory that we should not free */
+static bool DontFree(void *ptr)
+{
+       return (ptr >= (&bootstrapmemory[0]) && ptr < (&bootstrapmemory[BOOTSTRAPBYTES]));
 }
 
-/** Snapshotting realloc implementation for user programs. */
+/** @brief Snapshotting malloc implementation for user programs */
+void *malloc(size_t size)
+{
+       if (user_snapshot_space) {
+               void *tmp = mspace_malloc(user_snapshot_space, size);
+               ASSERT(tmp);
+               return tmp;
+       } 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 new operator 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 * operator new(size_t size) throw(std::bad_alloc) {
-       return malloc(size);
+/** @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);
+               std::memset(tmp, 0, size * num);
+               return tmp;
+       }
 }
 
-/** Snapshotting delete operator for user programs. */
+/** @brief Snapshotting new operator for user programs */
+void * operator new(size_t size) throw(std::bad_alloc)
+{
+       return malloc(size);
+}
 
-void operator delete(void *p) throw() {
+/** @brief Snapshotting delete operator for user programs */
+void operator delete(void *p) throw()
+{
        free(p);
 }
 
-/** Snapshotting new[] operator for user programs. */
-
-void * operator new[](size_t size) throw(std::bad_alloc) {
+/** @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. */
-
-void operator delete[](void *p, size_t size) {
+/** @brief Snapshotting delete[] operator for user programs */
+void operator delete[](void *p, size_t size)
+{
        free(p);
 }
+#endif /* USE_MPROTECT_SNAPSHOT */