Changeset 1810 for trunk/psLib/src/sysUtils/psMemory.h

Timestamp:

Sep 14, 2004, 1:48:25 PM (22 years ago)

Author:

desonia

Message:

adjustments to coorespond to adding persistent flag to psMemBlock, i.e.,
exclusion of internal library blocks in memory leak checks.

File:

• trunk/psLib/src/sysUtils/psMemory.h (modified) (3 diffs)

trunk/psLib/src/sysUtils/psMemory.h

@@ -12 +12 @@
  *  @ingroup MemoryManagement
  *
- *  @version $Revision: 1.29 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2004-08-23 22:36:03 $
+ *  @version $Revision: 1.30 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2004-09-14 23:48:25 $
  *
  *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -73 +73 @@
     pthread_mutex_t refCounterMutex;   ///< mutex to ensure exclusive access to reference counter
     psReferenceCount refCounter;       ///< how many times pointer is referenced
+    bool persistent;                   ///< marks if this non-user persistent data like error stack, etc.
     const void *endblock;              ///< initialised to p_psMEMMAGIC
 }
@@ -163 +164 @@
     void *ptr                          ///< the memory block
 );
+
+/** Set the memory as persistent so that it is ignored when detecting memory leaks.
+ *
+ *  Used to mark a memory block as persistent data within the library, 
+ *  i.e., non user-level data used to hold psLib's state or cache data.  Such
+ *  examples of this class of memory is psTrace's trace-levels and dynamic
+ *  error codes.
+ *
+ *  Memory marked as persistent is excluded from memory leak checks.
+ *
+ */
+void p_psMemSetPersistent(
+    void *ptr,                         ///< the memory block to operate on
+    bool value                         ///< true if memory is persistent, otherwise false
+);
+
+/** Get the memory's persistent flag.
+ *
+ *  Checks if a memory block has been marked as persistent by 
+ *  p_psMemSetPresistent.
+ *
+ *  Memory marked as persistent is excluded from memory leak checks.
+ *
+ *  @return bool    true if memory is marked persistent, otherwise false.
+ */
+bool p_psMemGetPersistent(
+    void *ptr                          ///< the memory block to check.
+);
+
 
 /** Memory re-allocation.  This operates much like realloc(), but is guaranteed to return a non-NULL value.