more documentation

[c11tester.git] / mymemory.cc

diff --git a/mymemory.cc b/mymemory.cc
index 0bbb7492dd3c1aef9987304a326678cde9484330..2b9c44d516282e1041487c6d0d1a5f1a78a1f472 100644 (file)
--- a/mymemory.cc
+++ b/mymemory.cc
@@ -7,6 +7,8 @@
 static mspace sStaticSpace = NULL;
 #endif
 
+/** Non-snapshotting malloc for our use. */
+
 void *MYMALLOC(size_t size) {
 #if USE_MPROTECT_SNAPSHOT
        static void *(*mallocp)(size_t size);
@@ -18,7 +20,7 @@ void *MYMALLOC(size_t size) {
                mallocp = ( void * ( * )( size_t ) )dlsym(RTLD_NEXT, "malloc");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
-                       exit(1);
+                       exit(EXIT_FAILURE);
                }
        }
        ptr = mallocp(size);     
@@ -43,7 +45,7 @@ void *system_malloc( size_t size ){
                mallocp = ( void * ( * )( size_t ) )dlsym(RTLD_NEXT, "malloc");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
-                       exit(1);
+                       exit(EXIT_FAILURE);
                }
        }
        ptr = mallocp(size);
@@ -59,11 +61,13 @@ void system_free( void * ptr ){
                freep = ( void  ( * )( void * ) )dlsym(RTLD_NEXT, "free");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
-                       exit(1);
+                       exit(EXIT_FAILURE);
                }
        }
        freep(ptr);
 }
+
+/** Non-snapshotting free for our use. */
 void MYFREE(void *ptr) {
 #if USE_MPROTECT_SNAPSHOT
        static void (*freep)(void *);
@@ -74,7 +78,7 @@ void MYFREE(void *ptr) {
                freep = ( void  ( * )( void * ) )dlsym(RTLD_NEXT, "free");
                if ((error = dlerror()) != NULL) {
                        fputs(error, stderr);
-                       exit(1);
+                       exit(EXIT_FAILURE);
                }
        }
        freep(ptr);
@@ -82,33 +86,54 @@ void MYFREE(void *ptr) {
        mspace_free( sStaticSpace, ptr );
 #endif
 }
+
+
+/** 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;
 
+//Subramanian --- please make these work for the fork based approach
+
+/** Snapshotting malloc implementation for user programs. */
+
 void *malloc( size_t size ) {
        return mspace_malloc( mySpace, size );
 }
 
+/** Snapshotting free implementation for user programs. */
+
 void free( void * ptr ){
        mspace_free( mySpace, ptr );
 }
 
+/** Snapshotting realloc implementation for user programs. */
+
 void *realloc( void *ptr, size_t size ){
        return mspace_realloc( mySpace, ptr, size );
 }
 
+/** 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) throw() {
        free(p);
 }
 
+/** 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) {
        free(p);
 }