From 4758da752ff819234c5019fa6fbe171be9e591ed Mon Sep 17 00:00:00 2001
From: Aleksey Bragin <aleksey@reactos.org>
Date: Thu, 14 Oct 2010 20:55:38 +0000
Subject: [PATCH] [HEAP] - Add special debug heap function declarations and
 stubs. - Add a useful inline for detecting whether a special or normal heap
 is going to be used.

svn path=/trunk/; revision=49149
---
 reactos/lib/rtl/heap.h    | 73 ++++++++++++++++++++++++++++++++++
 reactos/lib/rtl/heapdbg.c | 83 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 156 insertions(+)

diff --git a/reactos/lib/rtl/heap.h b/reactos/lib/rtl/heap.h
index 994ce07bc55..26ba0e79d78 100644
--- a/reactos/lib/rtl/heap.h
+++ b/reactos/lib/rtl/heap.h
@@ -54,6 +54,26 @@
 /* Segment flags */
 #define HEAP_USER_ALLOCATED    0x1
 
+/* A handy inline to distinguis normal heap, special "debug heap" and special "page heap" */
+FORCEINLINE BOOLEAN
+RtlpHeapIsSpecial(ULONG Flags)
+{
+    if (Flags & HEAP_SKIP_VALIDATION_CHECKS) return FALSE;
+
+    if (Flags & (HEAP_FLAG_PAGE_ALLOCS |
+                 HEAP_VALIDATE_ALL_ENABLED |
+                 HEAP_VALIDATE_PARAMETERS_ENABLED |
+                 HEAP_CAPTURE_STACK_BACKTRACES |
+                 HEAP_CREATE_ENABLE_TRACING))
+    {
+        /* This is a special heap */
+        return TRUE;
+    }
+
+    /* No need for a special treatment */
+    return FALSE;
+}
+
 /* Heap structures */
 struct _HEAP_COMMON_ENTRY
 {
@@ -303,6 +323,59 @@ PHEAP_ENTRY_EXTRA NTAPI
 RtlpGetExtraStuffPointer(PHEAP_ENTRY HeapEntry);
 
 /* heapdbg.c */
+HANDLE NTAPI
+RtlDebugCreateHeap(ULONG Flags,
+                   PVOID Addr,
+                   SIZE_T TotalSize,
+                   SIZE_T CommitSize,
+                   PVOID Lock,
+                   PRTL_HEAP_PARAMETERS Parameters);
+
+HANDLE NTAPI
+RtlDebugDestroyHeap(HANDLE HeapPtr);
+
+PVOID NTAPI
+RtlDebugAllocateHeap(PVOID HeapPtr,
+                     ULONG Flags,
+                     SIZE_T Size);
+
+PVOID NTAPI
+RtlDebugReAllocateHeap(HANDLE HeapPtr,
+                       ULONG Flags,
+                       PVOID Ptr,
+                       SIZE_T Size);
+
+BOOLEAN NTAPI
+RtlDebugFreeHeap(HANDLE HeapPtr,
+                 ULONG Flags,
+                 PVOID Ptr);
+
+BOOLEAN NTAPI
+RtlDebugGetUserInfoHeap(PVOID HeapHandle,
+                        ULONG Flags,
+                        PVOID BaseAddress,
+                        PVOID *UserValue,
+                        PULONG UserFlags);
+
+BOOLEAN NTAPI
+RtlDebugSetUserValueHeap(PVOID HeapHandle,
+                         ULONG Flags,
+                         PVOID BaseAddress,
+                         PVOID UserValue);
+
+BOOLEAN
+NTAPI
+RtlDebugSetUserFlagsHeap(PVOID HeapHandle,
+                         ULONG Flags,
+                         PVOID BaseAddress,
+                         ULONG UserFlagsReset,
+                         ULONG UserFlagsSet);
+
+SIZE_T NTAPI
+RtlDebugSizeHeap(HANDLE HeapPtr,
+                 ULONG Flags,
+                 PVOID Ptr);
+
 HANDLE NTAPI
 RtlpPageHeapCreate(ULONG Flags,
                    PVOID Addr,
diff --git a/reactos/lib/rtl/heapdbg.c b/reactos/lib/rtl/heapdbg.c
index 242dfacaf9b..d23c550a55d 100644
--- a/reactos/lib/rtl/heapdbg.c
+++ b/reactos/lib/rtl/heapdbg.c
@@ -22,6 +22,89 @@ WCHAR RtlpPageHeapTargetDlls[512];
 
 /* FUNCTIONS ******************************************************************/
 
+HANDLE NTAPI
+RtlDebugCreateHeap(ULONG Flags,
+                   PVOID Addr,
+                   SIZE_T TotalSize,
+                   SIZE_T CommitSize,
+                   PVOID Lock,
+                   PRTL_HEAP_PARAMETERS Parameters)
+{
+    return NULL;
+}
+
+HANDLE NTAPI
+RtlDebugDestroyHeap(HANDLE HeapPtr)
+{
+    return NULL;
+}
+
+PVOID NTAPI
+RtlDebugAllocateHeap(PVOID HeapPtr,
+                     ULONG Flags,
+                     SIZE_T Size)
+{
+    return NULL;
+}
+
+PVOID NTAPI
+RtlDebugReAllocateHeap(HANDLE HeapPtr,
+                       ULONG Flags,
+                       PVOID Ptr,
+                       SIZE_T Size)
+{
+    return NULL;
+}
+
+BOOLEAN NTAPI
+RtlDebugFreeHeap(HANDLE HeapPtr,
+                 ULONG Flags,
+                 PVOID Ptr)
+{
+    return FALSE;
+}
+
+BOOLEAN NTAPI
+RtlDebugGetUserInfoHeap(PVOID HeapHandle,
+                        ULONG Flags,
+                        PVOID BaseAddress,
+                        PVOID *UserValue,
+                        PULONG UserFlags)
+{
+    return FALSE;
+}
+
+BOOLEAN NTAPI
+RtlDebugSetUserValueHeap(PVOID HeapHandle,
+                         ULONG Flags,
+                         PVOID BaseAddress,
+                         PVOID UserValue)
+{
+    return FALSE;
+}
+
+BOOLEAN
+NTAPI
+RtlDebugSetUserFlagsHeap(PVOID HeapHandle,
+                         ULONG Flags,
+                         PVOID BaseAddress,
+                         ULONG UserFlagsReset,
+                         ULONG UserFlagsSet)
+{
+    return FALSE;
+}
+
+SIZE_T NTAPI
+RtlDebugSizeHeap(HANDLE HeapPtr,
+                 ULONG Flags,
+                 PVOID Ptr)
+{
+    return 0;
+}
+
+
+// Page heap -> move to another file
+
 HANDLE NTAPI
 RtlpPageHeapCreate(ULONG Flags,
                    PVOID Addr,