Changeset 22273 in vbox for trunk/include/iprt

Timestamp:

Aug 14, 2009 11:00:51 PM (16 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

51115

Message:

IPRT: Added RTHeapSimpleRelocate for saving and restoring of the heap.

File:

• trunk/include/iprt/heap.h (modified) (3 diffs)

trunk/include/iprt/heap.h

@@ -39 +39 @@
  * Initializes the heap.
  *
- * @returns IPRT status code on success.
+ * @returns IPRT status code.
  * @param   pHeap       Where to store the heap anchor block on success.
  * @param   pvMemory    Pointer to the heap memory.
@@ -49 +49 @@
  * Merge two simple heaps into one.
  *
- * The requiremet is of course that they next two each other memory wise.
+ * The requirement is of course that they next two each other memory wise.
  *
- * @returns IPRT status code on success.
+ * @returns IPRT status code.
  * @param   pHeap       Where to store the handle to the merged heap on success.
  * @param   Heap1       Handle to the first heap.
@@ -59 +59 @@
 RTDECL(int) RTHeapSimpleMerge(PRTHEAPSIMPLE pHeap, RTHEAPSIMPLE Heap1, RTHEAPSIMPLE Heap2);
 
+/** 
+ * Relocater the heap internal structures after copying it to a new location. 
+ *  
+ * This can be used when loading a saved heap. 
+ *  
+ * @returns IPRT status code. 
+ * @param   hHeap       Heap handle that has already been adjusted by to the new
+ *                      location.  That is to say, when calling
+ *                      RTHeapSimpleInit, the caller must note the offset of the
+ *                      returned heap handle into the heap memory.  This offset
+ *                      must be used when calcuating the handle value for the
+ *                      new location.  The offset may in some cases not be zero!
+ * @param   offDelta    The delta between the new and old location, i.e. what 
+ *                      should be added to the internal pointers.
+ */
+RTDECL(int) RTHeapSimpleRelocate(RTHEAPSIMPLE hHeap, uintptr_t offDelta);
+ 
 /**
  * Allocates memory from the specified simple heap.