kernel32/ntdll: Mark a variable as unused.
[wine] / dlls / ntdll / heap.c
1 /*
2  * Win32 heap functions
3  *
4  * Copyright 1996 Alexandre Julliard
5  * Copyright 1998 Ulrich Weigand
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 #include "config.h"
23 #include "wine/port.h"
24
25 #include <assert.h>
26 #include <stdlib.h>
27 #include <stdarg.h>
28 #include <stdio.h>
29 #include <string.h>
30 #ifdef HAVE_VALGRIND_MEMCHECK_H
31 #include <valgrind/memcheck.h>
32 #else
33 #define RUNNING_ON_VALGRIND 0
34 #endif
35
36 #define NONAMELESSUNION
37 #define NONAMELESSSTRUCT
38 #include "ntstatus.h"
39 #define WIN32_NO_STATUS
40 #include "windef.h"
41 #include "winnt.h"
42 #include "winternl.h"
43 #include "wine/list.h"
44 #include "wine/debug.h"
45 #include "wine/server.h"
46
47 WINE_DEFAULT_DEBUG_CHANNEL(heap);
48
49 /* Note: the heap data structures are loosely based on what Pietrek describes in his
50  * book 'Windows 95 System Programming Secrets', with some adaptations for
51  * better compatibility with NT.
52  */
53
54 typedef struct tagARENA_INUSE
55 {
56     DWORD  size;                    /* Block size; must be the first field */
57     DWORD  magic : 24;              /* Magic number */
58     DWORD  unused_bytes : 8;        /* Number of bytes in the block not used by user data (max value is HEAP_MIN_DATA_SIZE+HEAP_MIN_SHRINK_SIZE) */
59 } ARENA_INUSE;
60
61 typedef struct tagARENA_FREE
62 {
63     DWORD                 size;     /* Block size; must be the first field */
64     DWORD                 magic;    /* Magic number */
65     struct list           entry;    /* Entry in free list */
66 } ARENA_FREE;
67
68 typedef struct
69 {
70     struct list           entry;      /* entry in heap large blocks list */
71     SIZE_T                data_size;  /* size of user data */
72     SIZE_T                block_size; /* total size of virtual memory block */
73     DWORD                 pad[2];     /* padding to ensure 16-byte alignment of data */
74     DWORD                 size;       /* fields for compatibility with normal arenas */
75     DWORD                 magic;      /* these must remain at the end of the structure */
76 } ARENA_LARGE;
77
78 #define ARENA_FLAG_FREE        0x00000001  /* flags OR'ed with arena size */
79 #define ARENA_FLAG_PREV_FREE   0x00000002
80 #define ARENA_SIZE_MASK        (~3)
81 #define ARENA_LARGE_SIZE       0xfedcba90  /* magic value for 'size' field in large blocks */
82
83 /* Value for arena 'magic' field */
84 #define ARENA_INUSE_MAGIC      0x455355
85 #define ARENA_PENDING_MAGIC    0xbedead
86 #define ARENA_FREE_MAGIC       0x45455246
87 #define ARENA_LARGE_MAGIC      0x6752614c
88
89 #define ARENA_INUSE_FILLER     0x55
90 #define ARENA_TAIL_FILLER      0xab
91 #define ARENA_FREE_FILLER      0xfeeefeee
92
93 /* everything is aligned on 8 byte boundaries (16 for Win64) */
94 #define ALIGNMENT              (2*sizeof(void*))
95 #define LARGE_ALIGNMENT        16  /* large blocks have stricter alignment */
96 #define ARENA_OFFSET           (ALIGNMENT - sizeof(ARENA_INUSE))
97
98 C_ASSERT( sizeof(ARENA_LARGE) % LARGE_ALIGNMENT == 0 );
99
100 #define ROUND_SIZE(size)       ((((size) + ALIGNMENT - 1) & ~(ALIGNMENT-1)) + ARENA_OFFSET)
101
102 #define QUIET                  1           /* Suppress messages  */
103 #define NOISY                  0           /* Report all errors  */
104
105 /* minimum data size (without arenas) of an allocated block */
106 /* make sure that it's larger than a free list entry */
107 #define HEAP_MIN_DATA_SIZE    ROUND_SIZE(2 * sizeof(struct list))
108 /* minimum size that must remain to shrink an allocated block */
109 #define HEAP_MIN_SHRINK_SIZE  (HEAP_MIN_DATA_SIZE+sizeof(ARENA_FREE))
110 /* minimum size to start allocating large blocks */
111 #define HEAP_MIN_LARGE_BLOCK_SIZE  0x7f000
112 /* extra size to add at the end of block for tail checking */
113 #define HEAP_TAIL_EXTRA_SIZE(flags) \
114     ((flags & HEAP_TAIL_CHECKING_ENABLED) || RUNNING_ON_VALGRIND ? ALIGNMENT : 0)
115
116 /* Max size of the blocks on the free lists */
117 static const SIZE_T HEAP_freeListSizes[] =
118 {
119     0x10, 0x20, 0x30, 0x40, 0x60, 0x80, 0x100, 0x200, 0x400, 0x1000, ~0UL
120 };
121 #define HEAP_NB_FREE_LISTS  (sizeof(HEAP_freeListSizes)/sizeof(HEAP_freeListSizes[0]))
122
123 typedef union
124 {
125     ARENA_FREE  arena;
126     void       *alignment[4];
127 } FREE_LIST_ENTRY;
128
129 struct tagHEAP;
130
131 typedef struct tagSUBHEAP
132 {
133     void               *base;       /* Base address of the sub-heap memory block */
134     SIZE_T              size;       /* Size of the whole sub-heap */
135     SIZE_T              min_commit; /* Minimum committed size */
136     SIZE_T              commitSize; /* Committed size of the sub-heap */
137     struct list         entry;      /* Entry in sub-heap list */
138     struct tagHEAP     *heap;       /* Main heap structure */
139     DWORD               headerSize; /* Size of the heap header */
140     DWORD               magic;      /* Magic number */
141 } SUBHEAP;
142
143 #define SUBHEAP_MAGIC    ((DWORD)('S' | ('U'<<8) | ('B'<<16) | ('H'<<24)))
144
145 typedef struct tagHEAP
146 {
147     DWORD_PTR        unknown1[2];
148     DWORD            unknown2;
149     DWORD            flags;         /* Heap flags */
150     DWORD            force_flags;   /* Forced heap flags for debugging */
151     SUBHEAP          subheap;       /* First sub-heap */
152     struct list      entry;         /* Entry in process heap list */
153     struct list      subheap_list;  /* Sub-heap list */
154     struct list      large_list;    /* Large blocks list */
155     SIZE_T           grow_size;     /* Size of next subheap for growing heap */
156     DWORD            magic;         /* Magic number */
157     DWORD            pending_pos;   /* Position in pending free requests ring */
158     ARENA_INUSE    **pending_free;  /* Ring buffer for pending free requests */
159     RTL_CRITICAL_SECTION critSection; /* Critical section for serialization */
160     FREE_LIST_ENTRY *freeList;      /* Free lists */
161 } HEAP;
162
163 #define HEAP_MAGIC       ((DWORD)('H' | ('E'<<8) | ('A'<<16) | ('P'<<24)))
164
165 #define HEAP_DEF_SIZE        0x110000   /* Default heap size = 1Mb + 64Kb */
166 #define COMMIT_MASK          0xffff  /* bitmask for commit/decommit granularity */
167 #define MAX_FREE_PENDING     1024    /* max number of free requests to delay */
168
169 /* some undocumented flags (names are made up) */
170 #define HEAP_PAGE_ALLOCS      0x01000000
171 #define HEAP_VALIDATE         0x10000000
172 #define HEAP_VALIDATE_ALL     0x20000000
173 #define HEAP_VALIDATE_PARAMS  0x40000000
174
175 static HEAP *processHeap;  /* main process heap */
176
177 static BOOL HEAP_IsRealArena( HEAP *heapPtr, DWORD flags, LPCVOID block, BOOL quiet );
178
179 /* mark a block of memory as free for debugging purposes */
180 static inline void mark_block_free( void *ptr, SIZE_T size, DWORD flags )
181 {
182     if (flags & HEAP_FREE_CHECKING_ENABLED)
183     {
184         SIZE_T i;
185         for (i = 0; i < size / sizeof(DWORD); i++) ((DWORD *)ptr)[i] = ARENA_FREE_FILLER;
186     }
187 #if defined(VALGRIND_MAKE_MEM_NOACCESS)
188     VALGRIND_DISCARD( VALGRIND_MAKE_MEM_NOACCESS( ptr, size ));
189 #elif defined( VALGRIND_MAKE_NOACCESS)
190     VALGRIND_DISCARD( VALGRIND_MAKE_NOACCESS( ptr, size ));
191 #endif
192 }
193
194 /* mark a block of memory as initialized for debugging purposes */
195 static inline void mark_block_initialized( void *ptr, SIZE_T size )
196 {
197 #if defined(VALGRIND_MAKE_MEM_DEFINED)
198     VALGRIND_DISCARD( VALGRIND_MAKE_MEM_DEFINED( ptr, size ));
199 #elif defined(VALGRIND_MAKE_READABLE)
200     VALGRIND_DISCARD( VALGRIND_MAKE_READABLE( ptr, size ));
201 #endif
202 }
203
204 /* mark a block of memory as uninitialized for debugging purposes */
205 static inline void mark_block_uninitialized( void *ptr, SIZE_T size )
206 {
207 #if defined(VALGRIND_MAKE_MEM_UNDEFINED)
208     VALGRIND_DISCARD( VALGRIND_MAKE_MEM_UNDEFINED( ptr, size ));
209 #elif defined(VALGRIND_MAKE_WRITABLE)
210     VALGRIND_DISCARD( VALGRIND_MAKE_WRITABLE( ptr, size ));
211 #endif
212 }
213
214 /* mark a block of memory as a tail block */
215 static inline void mark_block_tail( void *ptr, SIZE_T size, DWORD flags )
216 {
217     if (flags & HEAP_TAIL_CHECKING_ENABLED)
218     {
219         mark_block_uninitialized( ptr, size );
220         memset( ptr, ARENA_TAIL_FILLER, size );
221     }
222 #if defined(VALGRIND_MAKE_MEM_NOACCESS)
223     VALGRIND_DISCARD( VALGRIND_MAKE_MEM_NOACCESS( ptr, size ));
224 #elif defined( VALGRIND_MAKE_NOACCESS)
225     VALGRIND_DISCARD( VALGRIND_MAKE_NOACCESS( ptr, size ));
226 #endif
227 }
228
229 /* initialize contents of a newly created block of memory */
230 static inline void initialize_block( void *ptr, SIZE_T size, SIZE_T unused, DWORD flags )
231 {
232     if (flags & HEAP_ZERO_MEMORY)
233     {
234         mark_block_initialized( ptr, size );
235         memset( ptr, 0, size );
236     }
237     else
238     {
239         mark_block_uninitialized( ptr, size );
240         if (flags & HEAP_FREE_CHECKING_ENABLED)
241         {
242             memset( ptr, ARENA_INUSE_FILLER, size );
243             mark_block_uninitialized( ptr, size );
244         }
245     }
246
247     mark_block_tail( (char *)ptr + size, unused, flags );
248 }
249
250 /* notify that a new block of memory has been allocated for debugging purposes */
251 static inline void notify_alloc( void *ptr, SIZE_T size, BOOL init )
252 {
253 #ifdef VALGRIND_MALLOCLIKE_BLOCK
254     VALGRIND_MALLOCLIKE_BLOCK( ptr, size, 0, init );
255 #endif
256 }
257
258 /* notify that a block of memory has been freed for debugging purposes */
259 static inline void notify_free( void const *ptr )
260 {
261 #ifdef VALGRIND_FREELIKE_BLOCK
262     VALGRIND_FREELIKE_BLOCK( ptr, 0 );
263 #endif
264 }
265
266 static void subheap_notify_free_all(SUBHEAP const *subheap)
267 {
268 #ifdef VALGRIND_FREELIKE_BLOCK
269     char const *ptr = (char const *)subheap->base + subheap->headerSize;
270
271     if (!RUNNING_ON_VALGRIND) return;
272
273     while (ptr < (char const *)subheap->base + subheap->size)
274     {
275         if (*(const DWORD *)ptr & ARENA_FLAG_FREE)
276         {
277             ARENA_FREE const *pArena = (ARENA_FREE const *)ptr;
278             if (pArena->magic!=ARENA_FREE_MAGIC) ERR("bad free_magic @%p\n", pArena);
279             ptr += sizeof(*pArena) + (pArena->size & ARENA_SIZE_MASK);
280         }
281         else
282         {
283             ARENA_INUSE const *pArena = (ARENA_INUSE const *)ptr;
284             if (pArena->magic == ARENA_INUSE_MAGIC) notify_free(pArena + 1);
285             else if (pArena->magic != ARENA_PENDING_MAGIC) ERR("bad inuse_magic @%p\n", pArena);
286             ptr += sizeof(*pArena) + (pArena->size & ARENA_SIZE_MASK);
287         }
288     }
289 #endif
290 }
291
292 /* locate a free list entry of the appropriate size */
293 /* size is the size of the whole block including the arena header */
294 static inline unsigned int get_freelist_index( SIZE_T size )
295 {
296     unsigned int i;
297
298     size -= sizeof(ARENA_FREE);
299     for (i = 0; i < HEAP_NB_FREE_LISTS - 1; i++) if (size <= HEAP_freeListSizes[i]) break;
300     return i;
301 }
302
303 /* get the memory protection type to use for a given heap */
304 static inline ULONG get_protection_type( DWORD flags )
305 {
306     return (flags & HEAP_CREATE_ENABLE_EXECUTE) ? PAGE_EXECUTE_READWRITE : PAGE_READWRITE;
307 }
308
309 static RTL_CRITICAL_SECTION_DEBUG process_heap_critsect_debug =
310 {
311     0, 0, NULL,  /* will be set later */
312     { &process_heap_critsect_debug.ProcessLocksList, &process_heap_critsect_debug.ProcessLocksList },
313       0, 0, { (DWORD_PTR)(__FILE__ ": main process heap section") }
314 };
315
316
317 /***********************************************************************
318  *           HEAP_Dump
319  */
320 static void HEAP_Dump( HEAP *heap )
321 {
322     unsigned int i;
323     SUBHEAP *subheap;
324     char *ptr;
325
326     DPRINTF( "Heap: %p\n", heap );
327     DPRINTF( "Next: %p  Sub-heaps:", LIST_ENTRY( heap->entry.next, HEAP, entry ) );
328     LIST_FOR_EACH_ENTRY( subheap, &heap->subheap_list, SUBHEAP, entry ) DPRINTF( " %p", subheap );
329
330     DPRINTF( "\nFree lists:\n Block   Stat   Size    Id\n" );
331     for (i = 0; i < HEAP_NB_FREE_LISTS; i++)
332         DPRINTF( "%p free %08lx prev=%p next=%p\n",
333                  &heap->freeList[i].arena, HEAP_freeListSizes[i],
334                  LIST_ENTRY( heap->freeList[i].arena.entry.prev, ARENA_FREE, entry ),
335                  LIST_ENTRY( heap->freeList[i].arena.entry.next, ARENA_FREE, entry ));
336
337     LIST_FOR_EACH_ENTRY( subheap, &heap->subheap_list, SUBHEAP, entry )
338     {
339         SIZE_T freeSize = 0, usedSize = 0, arenaSize = subheap->headerSize;
340         DPRINTF( "\n\nSub-heap %p: base=%p size=%08lx committed=%08lx\n",
341                  subheap, subheap->base, subheap->size, subheap->commitSize );
342
343         DPRINTF( "\n Block    Arena   Stat   Size    Id\n" );
344         ptr = (char *)subheap->base + subheap->headerSize;
345         while (ptr < (char *)subheap->base + subheap->size)
346         {
347             if (*(DWORD *)ptr & ARENA_FLAG_FREE)
348             {
349                 ARENA_FREE *pArena = (ARENA_FREE *)ptr;
350                 DPRINTF( "%p %08x free %08x prev=%p next=%p\n",
351                          pArena, pArena->magic,
352                          pArena->size & ARENA_SIZE_MASK,
353                          LIST_ENTRY( pArena->entry.prev, ARENA_FREE, entry ),
354                          LIST_ENTRY( pArena->entry.next, ARENA_FREE, entry ) );
355                 ptr += sizeof(*pArena) + (pArena->size & ARENA_SIZE_MASK);
356                 arenaSize += sizeof(ARENA_FREE);
357                 freeSize += pArena->size & ARENA_SIZE_MASK;
358             }
359             else if (*(DWORD *)ptr & ARENA_FLAG_PREV_FREE)
360             {
361                 ARENA_INUSE *pArena = (ARENA_INUSE *)ptr;
362                 DPRINTF( "%p %08x Used %08x back=%p\n",
363                         pArena, pArena->magic, pArena->size & ARENA_SIZE_MASK, *((ARENA_FREE **)pArena - 1) );
364                 ptr += sizeof(*pArena) + (pArena->size & ARENA_SIZE_MASK);
365                 arenaSize += sizeof(ARENA_INUSE);
366                 usedSize += pArena->size & ARENA_SIZE_MASK;
367             }
368             else
369             {
370                 ARENA_INUSE *pArena = (ARENA_INUSE *)ptr;
371                 DPRINTF( "%p %08x %s %08x\n",
372                          pArena, pArena->magic, pArena->magic == ARENA_INUSE_MAGIC ? "used" : "pend",
373                          pArena->size & ARENA_SIZE_MASK );
374                 ptr += sizeof(*pArena) + (pArena->size & ARENA_SIZE_MASK);
375                 arenaSize += sizeof(ARENA_INUSE);
376                 usedSize += pArena->size & ARENA_SIZE_MASK;
377             }
378         }
379         DPRINTF( "\nTotal: Size=%08lx Committed=%08lx Free=%08lx Used=%08lx Arenas=%08lx (%ld%%)\n\n",
380               subheap->size, subheap->commitSize, freeSize, usedSize,
381               arenaSize, (arenaSize * 100) / subheap->size );
382     }
383 }
384
385
386 static void HEAP_DumpEntry( LPPROCESS_HEAP_ENTRY entry )
387 {
388     WORD rem_flags;
389     TRACE( "Dumping entry %p\n", entry );
390     TRACE( "lpData\t\t: %p\n", entry->lpData );
391     TRACE( "cbData\t\t: %08x\n", entry->cbData);
392     TRACE( "cbOverhead\t: %08x\n", entry->cbOverhead);
393     TRACE( "iRegionIndex\t: %08x\n", entry->iRegionIndex);
394     TRACE( "WFlags\t\t: ");
395     if (entry->wFlags & PROCESS_HEAP_REGION)
396         TRACE( "PROCESS_HEAP_REGION ");
397     if (entry->wFlags & PROCESS_HEAP_UNCOMMITTED_RANGE)
398         TRACE( "PROCESS_HEAP_UNCOMMITTED_RANGE ");
399     if (entry->wFlags & PROCESS_HEAP_ENTRY_BUSY)
400         TRACE( "PROCESS_HEAP_ENTRY_BUSY ");
401     if (entry->wFlags & PROCESS_HEAP_ENTRY_MOVEABLE)
402         TRACE( "PROCESS_HEAP_ENTRY_MOVEABLE ");
403     if (entry->wFlags & PROCESS_HEAP_ENTRY_DDESHARE)
404         TRACE( "PROCESS_HEAP_ENTRY_DDESHARE ");
405     rem_flags = entry->wFlags &
406         ~(PROCESS_HEAP_REGION | PROCESS_HEAP_UNCOMMITTED_RANGE |
407           PROCESS_HEAP_ENTRY_BUSY | PROCESS_HEAP_ENTRY_MOVEABLE|
408           PROCESS_HEAP_ENTRY_DDESHARE);
409     if (rem_flags)
410         TRACE( "Unknown %08x", rem_flags);
411     TRACE( "\n");
412     if ((entry->wFlags & PROCESS_HEAP_ENTRY_BUSY )
413         && (entry->wFlags & PROCESS_HEAP_ENTRY_MOVEABLE))
414     {
415         /* Treat as block */
416         TRACE( "BLOCK->hMem\t\t:%p\n", entry->u.Block.hMem);
417     }
418     if (entry->wFlags & PROCESS_HEAP_REGION)
419     {
420         TRACE( "Region.dwCommittedSize\t:%08x\n",entry->u.Region.dwCommittedSize);
421         TRACE( "Region.dwUnCommittedSize\t:%08x\n",entry->u.Region.dwUnCommittedSize);
422         TRACE( "Region.lpFirstBlock\t:%p\n",entry->u.Region.lpFirstBlock);
423         TRACE( "Region.lpLastBlock\t:%p\n",entry->u.Region.lpLastBlock);
424     }
425 }
426
427 /***********************************************************************
428  *           HEAP_GetPtr
429  * RETURNS
430  *      Pointer to the heap
431  *      NULL: Failure
432  */
433 static HEAP *HEAP_GetPtr(
434              HANDLE heap /* [in] Handle to the heap */
435 ) {
436     HEAP *heapPtr = heap;
437     if (!heapPtr || (heapPtr->magic != HEAP_MAGIC))
438     {
439         ERR("Invalid heap %p!\n", heap );
440         return NULL;
441     }
442     if ((heapPtr->flags & HEAP_VALIDATE_ALL) && !HEAP_IsRealArena( heapPtr, 0, NULL, NOISY ))
443     {
444         if (TRACE_ON(heap))
445         {
446             HEAP_Dump( heapPtr );
447             assert( FALSE );
448         }
449         return NULL;
450     }
451     return heapPtr;
452 }
453
454
455 /***********************************************************************
456  *           HEAP_InsertFreeBlock
457  *
458  * Insert a free block into the free list.
459  */
460 static inline void HEAP_InsertFreeBlock( HEAP *heap, ARENA_FREE *pArena, BOOL last )
461 {
462     FREE_LIST_ENTRY *pEntry = heap->freeList + get_freelist_index( pArena->size + sizeof(*pArena) );
463     if (last)
464     {
465         /* insert at end of free list, i.e. before the next free list entry */
466         pEntry++;
467         if (pEntry == &heap->freeList[HEAP_NB_FREE_LISTS]) pEntry = heap->freeList;
468         list_add_before( &pEntry->arena.entry, &pArena->entry );
469     }
470     else
471     {
472         /* insert at head of free list */
473         list_add_after( &pEntry->arena.entry, &pArena->entry );
474     }
475     pArena->size |= ARENA_FLAG_FREE;
476 }
477
478
479 /***********************************************************************
480  *           HEAP_FindSubHeap
481  * Find the sub-heap containing a given address.
482  *
483  * RETURNS
484  *      Pointer: Success
485  *      NULL: Failure
486  */
487 static SUBHEAP *HEAP_FindSubHeap(
488                 const HEAP *heap, /* [in] Heap pointer */
489                 LPCVOID ptr ) /* [in] Address */
490 {
491     SUBHEAP *sub;
492     LIST_FOR_EACH_ENTRY( sub, &heap->subheap_list, SUBHEAP, entry )
493         if ((ptr >= sub->base) &&
494             ((const char *)ptr < (const char *)sub->base + sub->size - sizeof(ARENA_INUSE)))
495             return sub;
496     return NULL;
497 }
498
499
500 /***********************************************************************
501  *           HEAP_Commit
502  *
503  * Make sure the heap storage is committed for a given size in the specified arena.
504  */
505 static inline BOOL HEAP_Commit( SUBHEAP *subheap, ARENA_INUSE *pArena, SIZE_T data_size )
506 {
507     void *ptr = (char *)(pArena + 1) + data_size + sizeof(ARENA_FREE);
508     SIZE_T size = (char *)ptr - (char *)subheap->base;
509     size = (size + COMMIT_MASK) & ~COMMIT_MASK;
510     if (size > subheap->size) size = subheap->size;
511     if (size <= subheap->commitSize) return TRUE;
512     size -= subheap->commitSize;
513     ptr = (char *)subheap->base + subheap->commitSize;
514     if (NtAllocateVirtualMemory( NtCurrentProcess(), &ptr, 0,
515                                  &size, MEM_COMMIT, get_protection_type( subheap->heap->flags ) ))
516     {
517         WARN("Could not commit %08lx bytes at %p for heap %p\n",
518                  size, ptr, subheap->heap );
519         return FALSE;
520     }
521     subheap->commitSize += size;
522     return TRUE;
523 }
524
525
526 /***********************************************************************
527  *           HEAP_Decommit
528  *
529  * If possible, decommit the heap storage from (including) 'ptr'.
530  */
531 static inline BOOL HEAP_Decommit( SUBHEAP *subheap, void *ptr )
532 {
533     void *addr;
534     SIZE_T decommit_size;
535     SIZE_T size = (char *)ptr - (char *)subheap->base;
536
537     /* round to next block and add one full block */
538     size = ((size + COMMIT_MASK) & ~COMMIT_MASK) + COMMIT_MASK + 1;
539     size = max( size, subheap->min_commit );
540     if (size >= subheap->commitSize) return TRUE;
541     decommit_size = subheap->commitSize - size;
542     addr = (char *)subheap->base + size;
543
544     if (NtFreeVirtualMemory( NtCurrentProcess(), &addr, &decommit_size, MEM_DECOMMIT ))
545     {
546         WARN("Could not decommit %08lx bytes at %p for heap %p\n",
547              decommit_size, (char *)subheap->base + size, subheap->heap );
548         return FALSE;
549     }
550     subheap->commitSize -= decommit_size;
551     return TRUE;
552 }
553
554
555 /***********************************************************************
556  *           HEAP_CreateFreeBlock
557  *
558  * Create a free block at a specified address. 'size' is the size of the
559  * whole block, including the new arena.
560  */
561 static void HEAP_CreateFreeBlock( SUBHEAP *subheap, void *ptr, SIZE_T size )
562 {
563     ARENA_FREE *pFree;
564     char *pEnd;
565     BOOL last;
566     DWORD flags = subheap->heap->flags;
567
568     /* Create a free arena */
569     mark_block_uninitialized( ptr, sizeof(ARENA_FREE) );
570     pFree = ptr;
571     pFree->magic = ARENA_FREE_MAGIC;
572
573     /* If debugging, erase the freed block content */
574
575     pEnd = (char *)ptr + size;
576     if (pEnd > (char *)subheap->base + subheap->commitSize)
577         pEnd = (char *)subheap->base + subheap->commitSize;
578     if (pEnd > (char *)(pFree + 1)) mark_block_free( pFree + 1, pEnd - (char *)(pFree + 1), flags );
579
580     /* Check if next block is free also */
581
582     if (((char *)ptr + size < (char *)subheap->base + subheap->size) &&
583         (*(DWORD *)((char *)ptr + size) & ARENA_FLAG_FREE))
584     {
585         /* Remove the next arena from the free list */
586         ARENA_FREE *pNext = (ARENA_FREE *)((char *)ptr + size);
587         list_remove( &pNext->entry );
588         size += (pNext->size & ARENA_SIZE_MASK) + sizeof(*pNext);
589         mark_block_free( pNext, sizeof(ARENA_FREE), flags );
590     }
591
592     /* Set the next block PREV_FREE flag and pointer */
593
594     last = ((char *)ptr + size >= (char *)subheap->base + subheap->size);
595     if (!last)
596     {
597         DWORD *pNext = (DWORD *)((char *)ptr + size);
598         *pNext |= ARENA_FLAG_PREV_FREE;
599         mark_block_initialized( (ARENA_FREE **)pNext - 1, sizeof( ARENA_FREE * ) );
600         *((ARENA_FREE **)pNext - 1) = pFree;
601     }
602
603     /* Last, insert the new block into the free list */
604
605     pFree->size = size - sizeof(*pFree);
606     HEAP_InsertFreeBlock( subheap->heap, pFree, last );
607 }
608
609
610 /***********************************************************************
611  *           HEAP_MakeInUseBlockFree
612  *
613  * Turn an in-use block into a free block. Can also decommit the end of
614  * the heap, and possibly even free the sub-heap altogether.
615  */
616 static void HEAP_MakeInUseBlockFree( SUBHEAP *subheap, ARENA_INUSE *pArena )
617 {
618     HEAP *heap = subheap->heap;
619     ARENA_FREE *pFree;
620     SIZE_T size;
621
622     if (heap->pending_free)
623     {
624         ARENA_INUSE *prev = heap->pending_free[heap->pending_pos];
625         heap->pending_free[heap->pending_pos] = pArena;
626         heap->pending_pos = (heap->pending_pos + 1) % MAX_FREE_PENDING;
627         pArena->magic = ARENA_PENDING_MAGIC;
628         mark_block_free( pArena + 1, pArena->size & ARENA_SIZE_MASK, heap->flags );
629         if (!prev) return;
630         pArena = prev;
631         subheap = HEAP_FindSubHeap( heap, pArena );
632     }
633
634     /* Check if we can merge with previous block */
635
636     size = (pArena->size & ARENA_SIZE_MASK) + sizeof(*pArena);
637     if (pArena->size & ARENA_FLAG_PREV_FREE)
638     {
639         pFree = *((ARENA_FREE **)pArena - 1);
640         size += (pFree->size & ARENA_SIZE_MASK) + sizeof(ARENA_FREE);
641         /* Remove it from the free list */
642         list_remove( &pFree->entry );
643     }
644     else pFree = (ARENA_FREE *)pArena;
645
646     /* Create a free block */
647
648     HEAP_CreateFreeBlock( subheap, pFree, size );
649     size = (pFree->size & ARENA_SIZE_MASK) + sizeof(ARENA_FREE);
650     if ((char *)pFree + size < (char *)subheap->base + subheap->size)
651         return;  /* Not the last block, so nothing more to do */
652
653     /* Free the whole sub-heap if it's empty and not the original one */
654
655     if (((char *)pFree == (char *)subheap->base + subheap->headerSize) &&
656         (subheap != &subheap->heap->subheap))
657     {
658         void *addr = subheap->base;
659
660         size = 0;
661         /* Remove the free block from the list */
662         list_remove( &pFree->entry );
663         /* Remove the subheap from the list */
664         list_remove( &subheap->entry );
665         /* Free the memory */
666         subheap->magic = 0;
667         NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
668         return;
669     }
670
671     /* Decommit the end of the heap */
672
673     if (!(subheap->heap->flags & HEAP_SHARED)) HEAP_Decommit( subheap, pFree + 1 );
674 }
675
676
677 /***********************************************************************
678  *           HEAP_ShrinkBlock
679  *
680  * Shrink an in-use block.
681  */
682 static void HEAP_ShrinkBlock(SUBHEAP *subheap, ARENA_INUSE *pArena, SIZE_T size)
683 {
684     if ((pArena->size & ARENA_SIZE_MASK) >= size + HEAP_MIN_SHRINK_SIZE)
685     {
686         HEAP_CreateFreeBlock( subheap, (char *)(pArena + 1) + size,
687                               (pArena->size & ARENA_SIZE_MASK) - size );
688         /* assign size plus previous arena flags */
689         pArena->size = size | (pArena->size & ~ARENA_SIZE_MASK);
690     }
691     else
692     {
693         /* Turn off PREV_FREE flag in next block */
694         char *pNext = (char *)(pArena + 1) + (pArena->size & ARENA_SIZE_MASK);
695         if (pNext < (char *)subheap->base + subheap->size)
696             *(DWORD *)pNext &= ~ARENA_FLAG_PREV_FREE;
697     }
698 }
699
700
701 /***********************************************************************
702  *           allocate_large_block
703  */
704 static void *allocate_large_block( HEAP *heap, DWORD flags, SIZE_T size )
705 {
706     ARENA_LARGE *arena;
707     SIZE_T block_size = sizeof(*arena) + ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE(flags);
708     LPVOID address = NULL;
709
710     if (block_size < size) return NULL;  /* overflow */
711     if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 5,
712                                  &block_size, MEM_COMMIT, get_protection_type( flags ) ))
713     {
714         WARN("Could not allocate block for %08lx bytes\n", size );
715         return NULL;
716     }
717     arena = address;
718     arena->data_size = size;
719     arena->block_size = block_size;
720     arena->size = ARENA_LARGE_SIZE;
721     arena->magic = ARENA_LARGE_MAGIC;
722     mark_block_tail( (char *)(arena + 1) + size, block_size - sizeof(*arena) - size, flags );
723     list_add_tail( &heap->large_list, &arena->entry );
724     notify_alloc( arena + 1, size, flags & HEAP_ZERO_MEMORY );
725     return arena + 1;
726 }
727
728
729 /***********************************************************************
730  *           free_large_block
731  */
732 static void free_large_block( HEAP *heap, DWORD flags, void *ptr )
733 {
734     ARENA_LARGE *arena = (ARENA_LARGE *)ptr - 1;
735     LPVOID address = arena;
736     SIZE_T size = 0;
737
738     list_remove( &arena->entry );
739     NtFreeVirtualMemory( NtCurrentProcess(), &address, &size, MEM_RELEASE );
740 }
741
742
743 /***********************************************************************
744  *           realloc_large_block
745  */
746 static void *realloc_large_block( HEAP *heap, DWORD flags, void *ptr, SIZE_T size )
747 {
748     ARENA_LARGE *arena = (ARENA_LARGE *)ptr - 1;
749     void *new_ptr;
750
751     if (arena->block_size - sizeof(*arena) >= size)
752     {
753         SIZE_T unused = arena->block_size - sizeof(*arena) - size;
754
755         /* FIXME: we could remap zero-pages instead */
756         if (size > arena->data_size)
757             initialize_block( (char *)ptr + arena->data_size, size - arena->data_size, unused, flags );
758         else
759             mark_block_tail( (char *)ptr + size, unused, flags );
760         arena->data_size = size;
761         return ptr;
762     }
763     if (flags & HEAP_REALLOC_IN_PLACE_ONLY) return NULL;
764     if (!(new_ptr = allocate_large_block( heap, flags, size )))
765     {
766         WARN("Could not allocate block for %08lx bytes\n", size );
767         return NULL;
768     }
769     memcpy( new_ptr, ptr, arena->data_size );
770     free_large_block( heap, flags, ptr );
771     notify_free( ptr );
772     return new_ptr;
773 }
774
775
776 /***********************************************************************
777  *           find_large_block
778  */
779 static ARENA_LARGE *find_large_block( HEAP *heap, const void *ptr )
780 {
781     ARENA_LARGE *arena;
782
783     LIST_FOR_EACH_ENTRY( arena, &heap->large_list, ARENA_LARGE, entry )
784         if (ptr == arena + 1) return arena;
785
786     return NULL;
787 }
788
789
790 /***********************************************************************
791  *           validate_large_arena
792  */
793 static BOOL validate_large_arena( HEAP *heap, const ARENA_LARGE *arena, BOOL quiet )
794 {
795     DWORD flags = heap->flags;
796
797     if ((ULONG_PTR)arena % getpagesize())
798     {
799         if (quiet == NOISY)
800         {
801             ERR( "Heap %p: invalid large arena pointer %p\n", heap, arena );
802             if (TRACE_ON(heap)) HEAP_Dump( heap );
803         }
804         else if (WARN_ON(heap))
805         {
806             WARN( "Heap %p: unaligned arena pointer %p\n", heap, arena );
807             if (TRACE_ON(heap)) HEAP_Dump( heap );
808         }
809         return FALSE;
810     }
811     if (arena->size != ARENA_LARGE_SIZE || arena->magic != ARENA_LARGE_MAGIC)
812     {
813         if (quiet == NOISY)
814         {
815             ERR( "Heap %p: invalid large arena %p values %x/%x\n",
816                  heap, arena, arena->size, arena->magic );
817             if (TRACE_ON(heap)) HEAP_Dump( heap );
818         }
819         else if (WARN_ON(heap))
820         {
821             WARN( "Heap %p: invalid large arena %p values %x/%x\n",
822                   heap, arena, arena->size, arena->magic );
823             if (TRACE_ON(heap)) HEAP_Dump( heap );
824         }
825         return FALSE;
826     }
827     if (arena->data_size > arena->block_size - sizeof(*arena))
828     {
829         ERR( "Heap %p: invalid large arena %p size %lx/%lx\n",
830              heap, arena, arena->data_size, arena->block_size );
831         return FALSE;
832     }
833     if (flags & HEAP_TAIL_CHECKING_ENABLED)
834     {
835         SIZE_T i, unused = arena->block_size - sizeof(*arena) - arena->data_size;
836         const unsigned char *data = (const unsigned char *)(arena + 1) + arena->data_size;
837
838         for (i = 0; i < unused; i++)
839         {
840             if (data[i] == ARENA_TAIL_FILLER) continue;
841             ERR("Heap %p: block %p tail overwritten at %p (byte %lu/%lu == 0x%02x)\n",
842                 heap, arena + 1, data + i, i, unused, data[i] );
843             return FALSE;
844         }
845     }
846     return TRUE;
847 }
848
849
850 /***********************************************************************
851  *           HEAP_CreateSubHeap
852  */
853 static SUBHEAP *HEAP_CreateSubHeap( HEAP *heap, LPVOID address, DWORD flags,
854                                     SIZE_T commitSize, SIZE_T totalSize )
855 {
856     SUBHEAP *subheap;
857     FREE_LIST_ENTRY *pEntry;
858     unsigned int i;
859
860     if (!address)
861     {
862         if (!commitSize) commitSize = COMMIT_MASK + 1;
863         totalSize = min( totalSize, 0xffff0000 );  /* don't allow a heap larger than 4Gb */
864         if (totalSize < commitSize) totalSize = commitSize;
865         if (flags & HEAP_SHARED) commitSize = totalSize;  /* always commit everything in a shared heap */
866         commitSize = min( totalSize, (commitSize + COMMIT_MASK) & ~COMMIT_MASK );
867
868         /* allocate the memory block */
869         if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 5, &totalSize,
870                                      MEM_RESERVE, get_protection_type( flags ) ))
871         {
872             WARN("Could not allocate %08lx bytes\n", totalSize );
873             return NULL;
874         }
875         if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 0,
876                                      &commitSize, MEM_COMMIT, get_protection_type( flags ) ))
877         {
878             WARN("Could not commit %08lx bytes for sub-heap %p\n", commitSize, address );
879             return NULL;
880         }
881     }
882
883     if (heap)
884     {
885         /* If this is a secondary subheap, insert it into list */
886
887         subheap = address;
888         subheap->base       = address;
889         subheap->heap       = heap;
890         subheap->size       = totalSize;
891         subheap->min_commit = 0x10000;
892         subheap->commitSize = commitSize;
893         subheap->magic      = SUBHEAP_MAGIC;
894         subheap->headerSize = ROUND_SIZE( sizeof(SUBHEAP) );
895         list_add_head( &heap->subheap_list, &subheap->entry );
896     }
897     else
898     {
899         /* If this is a primary subheap, initialize main heap */
900
901         heap = address;
902         heap->flags         = flags;
903         heap->magic         = HEAP_MAGIC;
904         heap->grow_size     = max( HEAP_DEF_SIZE, totalSize );
905         list_init( &heap->subheap_list );
906         list_init( &heap->large_list );
907
908         subheap = &heap->subheap;
909         subheap->base       = address;
910         subheap->heap       = heap;
911         subheap->size       = totalSize;
912         subheap->min_commit = commitSize;
913         subheap->commitSize = commitSize;
914         subheap->magic      = SUBHEAP_MAGIC;
915         subheap->headerSize = ROUND_SIZE( sizeof(HEAP) );
916         list_add_head( &heap->subheap_list, &subheap->entry );
917
918         /* Build the free lists */
919
920         heap->freeList = (FREE_LIST_ENTRY *)((char *)heap + subheap->headerSize);
921         subheap->headerSize += HEAP_NB_FREE_LISTS * sizeof(FREE_LIST_ENTRY);
922         list_init( &heap->freeList[0].arena.entry );
923         for (i = 0, pEntry = heap->freeList; i < HEAP_NB_FREE_LISTS; i++, pEntry++)
924         {
925             pEntry->arena.size = 0 | ARENA_FLAG_FREE;
926             pEntry->arena.magic = ARENA_FREE_MAGIC;
927             if (i) list_add_after( &pEntry[-1].arena.entry, &pEntry->arena.entry );
928         }
929
930         /* Initialize critical section */
931
932         if (!processHeap)  /* do it by hand to avoid memory allocations */
933         {
934             heap->critSection.DebugInfo      = &process_heap_critsect_debug;
935             heap->critSection.LockCount      = -1;
936             heap->critSection.RecursionCount = 0;
937             heap->critSection.OwningThread   = 0;
938             heap->critSection.LockSemaphore  = 0;
939             heap->critSection.SpinCount      = 0;
940             process_heap_critsect_debug.CriticalSection = &heap->critSection;
941         }
942         else
943         {
944             RtlInitializeCriticalSection( &heap->critSection );
945             heap->critSection.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": HEAP.critSection");
946         }
947
948         if (flags & HEAP_SHARED)
949         {
950             /* let's assume that only one thread at a time will try to do this */
951             HANDLE sem = heap->critSection.LockSemaphore;
952             if (!sem) NtCreateSemaphore( &sem, SEMAPHORE_ALL_ACCESS, NULL, 0, 1 );
953
954             NtDuplicateObject( NtCurrentProcess(), sem, NtCurrentProcess(), &sem, 0, 0,
955                                DUP_HANDLE_MAKE_GLOBAL | DUP_HANDLE_SAME_ACCESS | DUP_HANDLE_CLOSE_SOURCE );
956             heap->critSection.LockSemaphore = sem;
957             RtlFreeHeap( processHeap, 0, heap->critSection.DebugInfo );
958             heap->critSection.DebugInfo = NULL;
959         }
960     }
961
962     /* Create the first free block */
963
964     HEAP_CreateFreeBlock( subheap, (LPBYTE)subheap->base + subheap->headerSize,
965                           subheap->size - subheap->headerSize );
966
967     return subheap;
968 }
969
970
971 /***********************************************************************
972  *           HEAP_FindFreeBlock
973  *
974  * Find a free block at least as large as the requested size, and make sure
975  * the requested size is committed.
976  */
977 static ARENA_FREE *HEAP_FindFreeBlock( HEAP *heap, SIZE_T size,
978                                        SUBHEAP **ppSubHeap )
979 {
980     SUBHEAP *subheap;
981     struct list *ptr;
982     SIZE_T total_size;
983     FREE_LIST_ENTRY *pEntry = heap->freeList + get_freelist_index( size + sizeof(ARENA_INUSE) );
984
985     /* Find a suitable free list, and in it find a block large enough */
986
987     ptr = &pEntry->arena.entry;
988     while ((ptr = list_next( &heap->freeList[0].arena.entry, ptr )))
989     {
990         ARENA_FREE *pArena = LIST_ENTRY( ptr, ARENA_FREE, entry );
991         SIZE_T arena_size = (pArena->size & ARENA_SIZE_MASK) +
992                             sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
993         if (arena_size >= size)
994         {
995             subheap = HEAP_FindSubHeap( heap, pArena );
996             if (!HEAP_Commit( subheap, (ARENA_INUSE *)pArena, size )) return NULL;
997             *ppSubHeap = subheap;
998             return pArena;
999         }
1000     }
1001
1002     /* If no block was found, attempt to grow the heap */
1003
1004     if (!(heap->flags & HEAP_GROWABLE))
1005     {
1006         WARN("Not enough space in heap %p for %08lx bytes\n", heap, size );
1007         return NULL;
1008     }
1009     /* make sure that we have a big enough size *committed* to fit another
1010      * last free arena in !
1011      * So just one heap struct, one first free arena which will eventually
1012      * get used, and a second free arena that might get assigned all remaining
1013      * free space in HEAP_ShrinkBlock() */
1014     total_size = size + ROUND_SIZE(sizeof(SUBHEAP)) + sizeof(ARENA_INUSE) + sizeof(ARENA_FREE);
1015     if (total_size < size) return NULL;  /* overflow */
1016
1017     if ((subheap = HEAP_CreateSubHeap( heap, NULL, heap->flags, total_size,
1018                                        max( heap->grow_size, total_size ) )))
1019     {
1020         if (heap->grow_size < 128 * 1024 * 1024) heap->grow_size *= 2;
1021     }
1022     else while (!subheap)  /* shrink the grow size again if we are running out of space */
1023     {
1024         if (heap->grow_size <= total_size || heap->grow_size <= 4 * 1024 * 1024) return NULL;
1025         heap->grow_size /= 2;
1026         subheap = HEAP_CreateSubHeap( heap, NULL, heap->flags, total_size,
1027                                       max( heap->grow_size, total_size ) );
1028     }
1029
1030     TRACE("created new sub-heap %p of %08lx bytes for heap %p\n",
1031           subheap, subheap->size, heap );
1032
1033     *ppSubHeap = subheap;
1034     return (ARENA_FREE *)((char *)subheap->base + subheap->headerSize);
1035 }
1036
1037
1038 /***********************************************************************
1039  *           HEAP_IsValidArenaPtr
1040  *
1041  * Check that the pointer is inside the range possible for arenas.
1042  */
1043 static BOOL HEAP_IsValidArenaPtr( const HEAP *heap, const ARENA_FREE *ptr )
1044 {
1045     unsigned int i;
1046     const SUBHEAP *subheap = HEAP_FindSubHeap( heap, ptr );
1047     if (!subheap) return FALSE;
1048     if ((const char *)ptr >= (const char *)subheap->base + subheap->headerSize) return TRUE;
1049     if (subheap != &heap->subheap) return FALSE;
1050     for (i = 0; i < HEAP_NB_FREE_LISTS; i++)
1051         if (ptr == &heap->freeList[i].arena) return TRUE;
1052     return FALSE;
1053 }
1054
1055
1056 /***********************************************************************
1057  *           HEAP_ValidateFreeArena
1058  */
1059 static BOOL HEAP_ValidateFreeArena( SUBHEAP *subheap, ARENA_FREE *pArena )
1060 {
1061     DWORD flags = subheap->heap->flags;
1062     SIZE_T size;
1063     ARENA_FREE *prev, *next;
1064     char *heapEnd = (char *)subheap->base + subheap->size;
1065
1066     /* Check for unaligned pointers */
1067     if ((ULONG_PTR)pArena % ALIGNMENT != ARENA_OFFSET)
1068     {
1069         ERR("Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1070         return FALSE;
1071     }
1072
1073     /* Check magic number */
1074     if (pArena->magic != ARENA_FREE_MAGIC)
1075     {
1076         ERR("Heap %p: invalid free arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1077         return FALSE;
1078     }
1079     /* Check size flags */
1080     if (!(pArena->size & ARENA_FLAG_FREE) ||
1081         (pArena->size & ARENA_FLAG_PREV_FREE))
1082     {
1083         ERR("Heap %p: bad flags %08x for free arena %p\n",
1084             subheap->heap, pArena->size & ~ARENA_SIZE_MASK, pArena );
1085         return FALSE;
1086     }
1087     /* Check arena size */
1088     size = pArena->size & ARENA_SIZE_MASK;
1089     if ((char *)(pArena + 1) + size > heapEnd)
1090     {
1091         ERR("Heap %p: bad size %08lx for free arena %p\n", subheap->heap, size, pArena );
1092         return FALSE;
1093     }
1094     /* Check that next pointer is valid */
1095     next = LIST_ENTRY( pArena->entry.next, ARENA_FREE, entry );
1096     if (!HEAP_IsValidArenaPtr( subheap->heap, next ))
1097     {
1098         ERR("Heap %p: bad next ptr %p for arena %p\n",
1099             subheap->heap, next, pArena );
1100         return FALSE;
1101     }
1102     /* Check that next arena is free */
1103     if (!(next->size & ARENA_FLAG_FREE) || (next->magic != ARENA_FREE_MAGIC))
1104     {
1105         ERR("Heap %p: next arena %p invalid for %p\n",
1106             subheap->heap, next, pArena );
1107         return FALSE;
1108     }
1109     /* Check that prev pointer is valid */
1110     prev = LIST_ENTRY( pArena->entry.prev, ARENA_FREE, entry );
1111     if (!HEAP_IsValidArenaPtr( subheap->heap, prev ))
1112     {
1113         ERR("Heap %p: bad prev ptr %p for arena %p\n",
1114             subheap->heap, prev, pArena );
1115         return FALSE;
1116     }
1117     /* Check that prev arena is free */
1118     if (!(prev->size & ARENA_FLAG_FREE) || (prev->magic != ARENA_FREE_MAGIC))
1119     {
1120         /* this often means that the prev arena got overwritten
1121          * by a memory write before that prev arena */
1122         ERR("Heap %p: prev arena %p invalid for %p\n",
1123             subheap->heap, prev, pArena );
1124         return FALSE;
1125     }
1126     /* Check that next block has PREV_FREE flag */
1127     if ((char *)(pArena + 1) + size < heapEnd)
1128     {
1129         if (!(*(DWORD *)((char *)(pArena + 1) + size) & ARENA_FLAG_PREV_FREE))
1130         {
1131             ERR("Heap %p: free arena %p next block has no PREV_FREE flag\n",
1132                 subheap->heap, pArena );
1133             return FALSE;
1134         }
1135         /* Check next block back pointer */
1136         if (*((ARENA_FREE **)((char *)(pArena + 1) + size) - 1) != pArena)
1137         {
1138             ERR("Heap %p: arena %p has wrong back ptr %p\n",
1139                 subheap->heap, pArena,
1140                 *((ARENA_FREE **)((char *)(pArena+1) + size) - 1));
1141             return FALSE;
1142         }
1143     }
1144     if (flags & HEAP_FREE_CHECKING_ENABLED)
1145     {
1146         DWORD *ptr = (DWORD *)(pArena + 1);
1147         char *end = (char *)(pArena + 1) + size;
1148
1149         if (end >= heapEnd) end = (char *)subheap->base + subheap->commitSize;
1150         else end -= sizeof(ARENA_FREE *);
1151         while (ptr < (DWORD *)end)
1152         {
1153             if (*ptr != ARENA_FREE_FILLER)
1154             {
1155                 ERR("Heap %p: free block %p overwritten at %p by %08x\n",
1156                     subheap->heap, (ARENA_INUSE *)pArena + 1, ptr, *ptr );
1157                 return FALSE;
1158             }
1159             ptr++;
1160         }
1161     }
1162     return TRUE;
1163 }
1164
1165
1166 /***********************************************************************
1167  *           HEAP_ValidateInUseArena
1168  */
1169 static BOOL HEAP_ValidateInUseArena( const SUBHEAP *subheap, const ARENA_INUSE *pArena, BOOL quiet )
1170 {
1171     SIZE_T size;
1172     DWORD i, flags = subheap->heap->flags;
1173     const char *heapEnd = (const char *)subheap->base + subheap->size;
1174
1175     /* Check for unaligned pointers */
1176     if ((ULONG_PTR)pArena % ALIGNMENT != ARENA_OFFSET)
1177     {
1178         if ( quiet == NOISY )
1179         {
1180             ERR( "Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1181             if ( TRACE_ON(heap) )
1182                 HEAP_Dump( subheap->heap );
1183         }
1184         else if ( WARN_ON(heap) )
1185         {
1186             WARN( "Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1187             if ( TRACE_ON(heap) )
1188                 HEAP_Dump( subheap->heap );
1189         }
1190         return FALSE;
1191     }
1192
1193     /* Check magic number */
1194     if (pArena->magic != ARENA_INUSE_MAGIC && pArena->magic != ARENA_PENDING_MAGIC)
1195     {
1196         if (quiet == NOISY) {
1197             ERR("Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1198             if (TRACE_ON(heap))
1199                HEAP_Dump( subheap->heap );
1200         }  else if (WARN_ON(heap)) {
1201             WARN("Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1202             if (TRACE_ON(heap))
1203                HEAP_Dump( subheap->heap );
1204         }
1205         return FALSE;
1206     }
1207     /* Check size flags */
1208     if (pArena->size & ARENA_FLAG_FREE)
1209     {
1210         ERR("Heap %p: bad flags %08x for in-use arena %p\n",
1211             subheap->heap, pArena->size & ~ARENA_SIZE_MASK, pArena );
1212         return FALSE;
1213     }
1214     /* Check arena size */
1215     size = pArena->size & ARENA_SIZE_MASK;
1216     if ((const char *)(pArena + 1) + size > heapEnd ||
1217         (const char *)(pArena + 1) + size < (const char *)(pArena + 1))
1218     {
1219         ERR("Heap %p: bad size %08lx for in-use arena %p\n", subheap->heap, size, pArena );
1220         return FALSE;
1221     }
1222     /* Check next arena PREV_FREE flag */
1223     if (((const char *)(pArena + 1) + size < heapEnd) &&
1224         (*(const DWORD *)((const char *)(pArena + 1) + size) & ARENA_FLAG_PREV_FREE))
1225     {
1226         ERR("Heap %p: in-use arena %p next block %p has PREV_FREE flag %x\n",
1227             subheap->heap, pArena, (const char *)(pArena + 1) + size,*(const DWORD *)((const char *)(pArena + 1) + size) );
1228         return FALSE;
1229     }
1230     /* Check prev free arena */
1231     if (pArena->size & ARENA_FLAG_PREV_FREE)
1232     {
1233         const ARENA_FREE *pPrev = *((const ARENA_FREE * const*)pArena - 1);
1234         /* Check prev pointer */
1235         if (!HEAP_IsValidArenaPtr( subheap->heap, pPrev ))
1236         {
1237             ERR("Heap %p: bad back ptr %p for arena %p\n",
1238                 subheap->heap, pPrev, pArena );
1239             return FALSE;
1240         }
1241         /* Check that prev arena is free */
1242         if (!(pPrev->size & ARENA_FLAG_FREE) ||
1243             (pPrev->magic != ARENA_FREE_MAGIC))
1244         {
1245             ERR("Heap %p: prev arena %p invalid for in-use %p\n",
1246                 subheap->heap, pPrev, pArena );
1247             return FALSE;
1248         }
1249         /* Check that prev arena is really the previous block */
1250         if ((const char *)(pPrev + 1) + (pPrev->size & ARENA_SIZE_MASK) != (const char *)pArena)
1251         {
1252             ERR("Heap %p: prev arena %p is not prev for in-use %p\n",
1253                 subheap->heap, pPrev, pArena );
1254             return FALSE;
1255         }
1256     }
1257     /* Check unused size */
1258     if (pArena->unused_bytes > size)
1259     {
1260         ERR("Heap %p: invalid unused size %08x/%08lx\n", subheap->heap, pArena->unused_bytes, size );
1261         return FALSE;
1262     }
1263     /* Check unused bytes */
1264     if (pArena->magic == ARENA_PENDING_MAGIC)
1265     {
1266         const DWORD *ptr = (const DWORD *)(pArena + 1);
1267         const DWORD *end = (const DWORD *)((const char *)ptr + size);
1268
1269         while (ptr < end)
1270         {
1271             if (*ptr != ARENA_FREE_FILLER)
1272             {
1273                 ERR("Heap %p: free block %p overwritten at %p by %08x\n",
1274                     subheap->heap, (const ARENA_INUSE *)pArena + 1, ptr, *ptr );
1275                 if (!*ptr) { HEAP_Dump( subheap->heap ); DbgBreakPoint(); }
1276                 return FALSE;
1277             }
1278             ptr++;
1279         }
1280     }
1281     else if (flags & HEAP_TAIL_CHECKING_ENABLED)
1282     {
1283         const unsigned char *data = (const unsigned char *)(pArena + 1) + size - pArena->unused_bytes;
1284
1285         for (i = 0; i < pArena->unused_bytes; i++)
1286         {
1287             if (data[i] == ARENA_TAIL_FILLER) continue;
1288             ERR("Heap %p: block %p tail overwritten at %p (byte %u/%u == 0x%02x)\n",
1289                 subheap->heap, pArena + 1, data + i, i, pArena->unused_bytes, data[i] );
1290             return FALSE;
1291         }
1292     }
1293     return TRUE;
1294 }
1295
1296
1297 /***********************************************************************
1298  *           HEAP_IsRealArena  [Internal]
1299  * Validates a block is a valid arena.
1300  *
1301  * RETURNS
1302  *      TRUE: Success
1303  *      FALSE: Failure
1304  */
1305 static BOOL HEAP_IsRealArena( HEAP *heapPtr,   /* [in] ptr to the heap */
1306               DWORD flags,   /* [in] Bit flags that control access during operation */
1307               LPCVOID block, /* [in] Optional pointer to memory block to validate */
1308               BOOL quiet )   /* [in] Flag - if true, HEAP_ValidateInUseArena
1309                               *             does not complain    */
1310 {
1311     SUBHEAP *subheap;
1312     BOOL ret = TRUE;
1313     const ARENA_LARGE *large_arena;
1314
1315     flags &= HEAP_NO_SERIALIZE;
1316     flags |= heapPtr->flags;
1317     /* calling HeapLock may result in infinite recursion, so do the critsect directly */
1318     if (!(flags & HEAP_NO_SERIALIZE))
1319         RtlEnterCriticalSection( &heapPtr->critSection );
1320
1321     if (block)  /* only check this single memory block */
1322     {
1323         const ARENA_INUSE *arena = (const ARENA_INUSE *)block - 1;
1324
1325         if (!(subheap = HEAP_FindSubHeap( heapPtr, arena )) ||
1326             ((const char *)arena < (char *)subheap->base + subheap->headerSize))
1327         {
1328             if (!(large_arena = find_large_block( heapPtr, block )))
1329             {
1330                 if (quiet == NOISY)
1331                     ERR("Heap %p: block %p is not inside heap\n", heapPtr, block );
1332                 else if (WARN_ON(heap))
1333                     WARN("Heap %p: block %p is not inside heap\n", heapPtr, block );
1334                 ret = FALSE;
1335             }
1336             else
1337                 ret = validate_large_arena( heapPtr, large_arena, quiet );
1338         } else
1339             ret = HEAP_ValidateInUseArena( subheap, arena, quiet );
1340
1341         if (!(flags & HEAP_NO_SERIALIZE))
1342             RtlLeaveCriticalSection( &heapPtr->critSection );
1343         return ret;
1344     }
1345
1346     LIST_FOR_EACH_ENTRY( subheap, &heapPtr->subheap_list, SUBHEAP, entry )
1347     {
1348         char *ptr = (char *)subheap->base + subheap->headerSize;
1349         while (ptr < (char *)subheap->base + subheap->size)
1350         {
1351             if (*(DWORD *)ptr & ARENA_FLAG_FREE)
1352             {
1353                 if (!HEAP_ValidateFreeArena( subheap, (ARENA_FREE *)ptr )) {
1354                     ret = FALSE;
1355                     break;
1356                 }
1357                 ptr += sizeof(ARENA_FREE) + (*(DWORD *)ptr & ARENA_SIZE_MASK);
1358             }
1359             else
1360             {
1361                 if (!HEAP_ValidateInUseArena( subheap, (ARENA_INUSE *)ptr, NOISY )) {
1362                     ret = FALSE;
1363                     break;
1364                 }
1365                 ptr += sizeof(ARENA_INUSE) + (*(DWORD *)ptr & ARENA_SIZE_MASK);
1366             }
1367         }
1368         if (!ret) break;
1369     }
1370
1371     LIST_FOR_EACH_ENTRY( large_arena, &heapPtr->large_list, ARENA_LARGE, entry )
1372         if (!(ret = validate_large_arena( heapPtr, large_arena, quiet ))) break;
1373
1374     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1375     return ret;
1376 }
1377
1378
1379 /***********************************************************************
1380  *           validate_block_pointer
1381  *
1382  * Minimum validation needed to catch bad parameters in heap functions.
1383  */
1384 static BOOL validate_block_pointer( HEAP *heap, SUBHEAP **ret_subheap, const ARENA_INUSE *arena )
1385 {
1386     SUBHEAP *subheap;
1387     BOOL ret = FALSE;
1388
1389     if (!(*ret_subheap = subheap = HEAP_FindSubHeap( heap, arena )))
1390     {
1391         ARENA_LARGE *large_arena = find_large_block( heap, arena + 1 );
1392
1393         if (!large_arena)
1394         {
1395             WARN( "Heap %p: pointer %p is not inside heap\n", heap, arena + 1 );
1396             return FALSE;
1397         }
1398         if ((heap->flags & HEAP_VALIDATE) && !validate_large_arena( heap, large_arena, QUIET ))
1399             return FALSE;
1400         return TRUE;
1401     }
1402
1403     if ((const char *)arena < (char *)subheap->base + subheap->headerSize)
1404         WARN( "Heap %p: pointer %p is inside subheap %p header\n", subheap->heap, arena + 1, subheap );
1405     else if (subheap->heap->flags & HEAP_VALIDATE)  /* do the full validation */
1406         ret = HEAP_ValidateInUseArena( subheap, arena, QUIET );
1407     else if ((ULONG_PTR)arena % ALIGNMENT != ARENA_OFFSET)
1408         WARN( "Heap %p: unaligned arena pointer %p\n", subheap->heap, arena );
1409     else if (arena->magic == ARENA_PENDING_MAGIC)
1410         WARN( "Heap %p: block %p used after free\n", subheap->heap, arena + 1 );
1411     else if (arena->magic != ARENA_INUSE_MAGIC)
1412         WARN( "Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, arena->magic, arena );
1413     else if (arena->size & ARENA_FLAG_FREE)
1414         ERR( "Heap %p: bad flags %08x for in-use arena %p\n",
1415              subheap->heap, arena->size & ~ARENA_SIZE_MASK, arena );
1416     else if ((const char *)(arena + 1) + (arena->size & ARENA_SIZE_MASK) > (const char *)subheap->base + subheap->size ||
1417              (const char *)(arena + 1) + (arena->size & ARENA_SIZE_MASK) < (const char *)(arena + 1))
1418         ERR( "Heap %p: bad size %08x for in-use arena %p\n",
1419              subheap->heap, arena->size & ARENA_SIZE_MASK, arena );
1420     else
1421         ret = TRUE;
1422
1423     return ret;
1424 }
1425
1426
1427 /***********************************************************************
1428  *           heap_set_debug_flags
1429  */
1430 void heap_set_debug_flags( HANDLE handle )
1431 {
1432     HEAP *heap = HEAP_GetPtr( handle );
1433     ULONG global_flags = RtlGetNtGlobalFlags();
1434     ULONG flags = 0;
1435
1436     if (TRACE_ON(heap)) global_flags |= FLG_HEAP_VALIDATE_ALL;
1437     if (WARN_ON(heap)) global_flags |= FLG_HEAP_VALIDATE_PARAMETERS;
1438
1439     if (global_flags & FLG_HEAP_ENABLE_TAIL_CHECK) flags |= HEAP_TAIL_CHECKING_ENABLED;
1440     if (global_flags & FLG_HEAP_ENABLE_FREE_CHECK) flags |= HEAP_FREE_CHECKING_ENABLED;
1441     if (global_flags & FLG_HEAP_DISABLE_COALESCING) flags |= HEAP_DISABLE_COALESCE_ON_FREE;
1442     if (global_flags & FLG_HEAP_PAGE_ALLOCS) flags |= HEAP_PAGE_ALLOCS | HEAP_GROWABLE;
1443
1444     if (global_flags & FLG_HEAP_VALIDATE_PARAMETERS)
1445         flags |= HEAP_VALIDATE | HEAP_VALIDATE_PARAMS |
1446                  HEAP_TAIL_CHECKING_ENABLED | HEAP_FREE_CHECKING_ENABLED;
1447     if (global_flags & FLG_HEAP_VALIDATE_ALL)
1448         flags |= HEAP_VALIDATE | HEAP_VALIDATE_ALL |
1449                  HEAP_TAIL_CHECKING_ENABLED | HEAP_FREE_CHECKING_ENABLED;
1450
1451     if (RUNNING_ON_VALGRIND) flags = 0; /* no sense in validating since Valgrind catches accesses */
1452
1453     heap->flags |= flags;
1454     heap->force_flags |= flags & ~(HEAP_VALIDATE | HEAP_DISABLE_COALESCE_ON_FREE);
1455
1456     if (flags & (HEAP_FREE_CHECKING_ENABLED | HEAP_TAIL_CHECKING_ENABLED))  /* fix existing blocks */
1457     {
1458         SUBHEAP *subheap;
1459         ARENA_LARGE *large;
1460
1461         LIST_FOR_EACH_ENTRY( subheap, &heap->subheap_list, SUBHEAP, entry )
1462         {
1463             char *ptr = (char *)subheap->base + subheap->headerSize;
1464             char *end = (char *)subheap->base + subheap->commitSize;
1465             while (ptr < end)
1466             {
1467                 ARENA_INUSE *arena = (ARENA_INUSE *)ptr;
1468                 SIZE_T size = arena->size & ARENA_SIZE_MASK;
1469                 if (arena->size & ARENA_FLAG_FREE)
1470                 {
1471                     SIZE_T count = size;
1472
1473                     ptr += sizeof(ARENA_FREE) + size;
1474                     if (ptr >= end) count = end - (char *)((ARENA_FREE *)arena + 1);
1475                     else count -= sizeof(ARENA_FREE *);
1476                     mark_block_free( (ARENA_FREE *)arena + 1, count, flags );
1477                 }
1478                 else
1479                 {
1480                     if (arena->magic == ARENA_PENDING_MAGIC)
1481                         mark_block_free( arena + 1, size, flags );
1482                     else
1483                         mark_block_tail( (char *)(arena + 1) + size - arena->unused_bytes,
1484                                          arena->unused_bytes, flags );
1485                     ptr += sizeof(ARENA_INUSE) + size;
1486                 }
1487             }
1488         }
1489
1490         LIST_FOR_EACH_ENTRY( large, &heap->large_list, ARENA_LARGE, entry )
1491             mark_block_tail( (char *)(large + 1) + large->data_size,
1492                              large->block_size - sizeof(*large) - large->data_size, flags );
1493     }
1494
1495     if ((heap->flags & HEAP_GROWABLE) && !heap->pending_free &&
1496         ((flags & HEAP_FREE_CHECKING_ENABLED) || RUNNING_ON_VALGRIND))
1497     {
1498         void *ptr = NULL;
1499         SIZE_T size = MAX_FREE_PENDING * sizeof(*heap->pending_free);
1500
1501         if (!NtAllocateVirtualMemory( NtCurrentProcess(), &ptr, 4, &size, MEM_COMMIT, PAGE_READWRITE ))
1502         {
1503             heap->pending_free = ptr;
1504             heap->pending_pos = 0;
1505         }
1506     }
1507 }
1508
1509
1510 /***********************************************************************
1511  *           RtlCreateHeap   (NTDLL.@)
1512  *
1513  * Create a new Heap.
1514  *
1515  * PARAMS
1516  *  flags      [I] HEAP_ flags from "winnt.h"
1517  *  addr       [I] Desired base address
1518  *  totalSize  [I] Total size of the heap, or 0 for a growable heap
1519  *  commitSize [I] Amount of heap space to commit
1520  *  unknown    [I] Not yet understood
1521  *  definition [I] Heap definition
1522  *
1523  * RETURNS
1524  *  Success: A HANDLE to the newly created heap.
1525  *  Failure: a NULL HANDLE.
1526  */
1527 HANDLE WINAPI RtlCreateHeap( ULONG flags, PVOID addr, SIZE_T totalSize, SIZE_T commitSize,
1528                              PVOID unknown, PRTL_HEAP_DEFINITION definition )
1529 {
1530     SUBHEAP *subheap;
1531
1532     /* Allocate the heap block */
1533
1534     if (!totalSize)
1535     {
1536         totalSize = HEAP_DEF_SIZE;
1537         flags |= HEAP_GROWABLE;
1538     }
1539
1540     if (!(subheap = HEAP_CreateSubHeap( NULL, addr, flags, commitSize, totalSize ))) return 0;
1541
1542     heap_set_debug_flags( subheap->heap );
1543
1544     /* link it into the per-process heap list */
1545     if (processHeap)
1546     {
1547         HEAP *heapPtr = subheap->heap;
1548         RtlEnterCriticalSection( &processHeap->critSection );
1549         list_add_head( &processHeap->entry, &heapPtr->entry );
1550         RtlLeaveCriticalSection( &processHeap->critSection );
1551     }
1552     else if (!addr)
1553     {
1554         processHeap = subheap->heap;  /* assume the first heap we create is the process main heap */
1555         list_init( &processHeap->entry );
1556     }
1557
1558     return subheap->heap;
1559 }
1560
1561
1562 /***********************************************************************
1563  *           RtlDestroyHeap   (NTDLL.@)
1564  *
1565  * Destroy a Heap created with RtlCreateHeap().
1566  *
1567  * PARAMS
1568  *  heap [I] Heap to destroy.
1569  *
1570  * RETURNS
1571  *  Success: A NULL HANDLE, if heap is NULL or it was destroyed
1572  *  Failure: The Heap handle, if heap is the process heap.
1573  */
1574 HANDLE WINAPI RtlDestroyHeap( HANDLE heap )
1575 {
1576     HEAP *heapPtr = HEAP_GetPtr( heap );
1577     SUBHEAP *subheap, *next;
1578     ARENA_LARGE *arena, *arena_next;
1579     SIZE_T size;
1580     void *addr;
1581
1582     TRACE("%p\n", heap );
1583     if (!heapPtr) return heap;
1584
1585     if (heap == processHeap) return heap; /* cannot delete the main process heap */
1586
1587     /* remove it from the per-process list */
1588     RtlEnterCriticalSection( &processHeap->critSection );
1589     list_remove( &heapPtr->entry );
1590     RtlLeaveCriticalSection( &processHeap->critSection );
1591
1592     heapPtr->critSection.DebugInfo->Spare[0] = 0;
1593     RtlDeleteCriticalSection( &heapPtr->critSection );
1594
1595     LIST_FOR_EACH_ENTRY_SAFE( arena, arena_next, &heapPtr->large_list, ARENA_LARGE, entry )
1596     {
1597         list_remove( &arena->entry );
1598         size = 0;
1599         addr = arena;
1600         NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1601     }
1602     LIST_FOR_EACH_ENTRY_SAFE( subheap, next, &heapPtr->subheap_list, SUBHEAP, entry )
1603     {
1604         if (subheap == &heapPtr->subheap) continue;  /* do this one last */
1605         subheap_notify_free_all(subheap);
1606         list_remove( &subheap->entry );
1607         size = 0;
1608         addr = subheap->base;
1609         NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1610     }
1611     subheap_notify_free_all(&heapPtr->subheap);
1612     if (heapPtr->pending_free)
1613     {
1614         size = 0;
1615         addr = heapPtr->pending_free;
1616         NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1617     }
1618     size = 0;
1619     addr = heapPtr->subheap.base;
1620     NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1621     return 0;
1622 }
1623
1624
1625 /***********************************************************************
1626  *           RtlAllocateHeap   (NTDLL.@)
1627  *
1628  * Allocate a memory block from a Heap.
1629  *
1630  * PARAMS
1631  *  heap  [I] Heap to allocate block from
1632  *  flags [I] HEAP_ flags from "winnt.h"
1633  *  size  [I] Size of the memory block to allocate
1634  *
1635  * RETURNS
1636  *  Success: A pointer to the newly allocated block
1637  *  Failure: NULL.
1638  *
1639  * NOTES
1640  *  This call does not SetLastError().
1641  */
1642 PVOID WINAPI RtlAllocateHeap( HANDLE heap, ULONG flags, SIZE_T size )
1643 {
1644     ARENA_FREE *pArena;
1645     ARENA_INUSE *pInUse;
1646     SUBHEAP *subheap;
1647     HEAP *heapPtr = HEAP_GetPtr( heap );
1648     SIZE_T rounded_size;
1649
1650     /* Validate the parameters */
1651
1652     if (!heapPtr) return NULL;
1653     flags &= HEAP_GENERATE_EXCEPTIONS | HEAP_NO_SERIALIZE | HEAP_ZERO_MEMORY;
1654     flags |= heapPtr->flags;
1655     rounded_size = ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE( flags );
1656     if (rounded_size < size)  /* overflow */
1657     {
1658         if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1659         return NULL;
1660     }
1661     if (rounded_size < HEAP_MIN_DATA_SIZE) rounded_size = HEAP_MIN_DATA_SIZE;
1662
1663     if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1664
1665     if (rounded_size >= HEAP_MIN_LARGE_BLOCK_SIZE && (flags & HEAP_GROWABLE))
1666     {
1667         void *ret = allocate_large_block( heap, flags, size );
1668         if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1669         if (!ret && (flags & HEAP_GENERATE_EXCEPTIONS)) RtlRaiseStatus( STATUS_NO_MEMORY );
1670         TRACE("(%p,%08x,%08lx): returning %p\n", heap, flags, size, ret );
1671         return ret;
1672     }
1673
1674     /* Locate a suitable free block */
1675
1676     if (!(pArena = HEAP_FindFreeBlock( heapPtr, rounded_size, &subheap )))
1677     {
1678         TRACE("(%p,%08x,%08lx): returning NULL\n",
1679                   heap, flags, size  );
1680         if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1681         if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1682         return NULL;
1683     }
1684
1685     /* Remove the arena from the free list */
1686
1687     list_remove( &pArena->entry );
1688
1689     /* Build the in-use arena */
1690
1691     pInUse = (ARENA_INUSE *)pArena;
1692
1693     /* in-use arena is smaller than free arena,
1694      * so we have to add the difference to the size */
1695     pInUse->size  = (pInUse->size & ~ARENA_FLAG_FREE) + sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
1696     pInUse->magic = ARENA_INUSE_MAGIC;
1697
1698     /* Shrink the block */
1699
1700     HEAP_ShrinkBlock( subheap, pInUse, rounded_size );
1701     pInUse->unused_bytes = (pInUse->size & ARENA_SIZE_MASK) - size;
1702
1703     notify_alloc( pInUse + 1, size, flags & HEAP_ZERO_MEMORY );
1704     initialize_block( pInUse + 1, size, pInUse->unused_bytes, flags );
1705
1706     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1707
1708     TRACE("(%p,%08x,%08lx): returning %p\n", heap, flags, size, pInUse + 1 );
1709     return pInUse + 1;
1710 }
1711
1712
1713 /***********************************************************************
1714  *           RtlFreeHeap   (NTDLL.@)
1715  *
1716  * Free a memory block allocated with RtlAllocateHeap().
1717  *
1718  * PARAMS
1719  *  heap  [I] Heap that block was allocated from
1720  *  flags [I] HEAP_ flags from "winnt.h"
1721  *  ptr   [I] Block to free
1722  *
1723  * RETURNS
1724  *  Success: TRUE, if ptr is NULL or was freed successfully.
1725  *  Failure: FALSE.
1726  */
1727 BOOLEAN WINAPI RtlFreeHeap( HANDLE heap, ULONG flags, PVOID ptr )
1728 {
1729     ARENA_INUSE *pInUse;
1730     SUBHEAP *subheap;
1731     HEAP *heapPtr;
1732
1733     /* Validate the parameters */
1734
1735     if (!ptr) return TRUE;  /* freeing a NULL ptr isn't an error in Win2k */
1736
1737     heapPtr = HEAP_GetPtr( heap );
1738     if (!heapPtr)
1739     {
1740         RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
1741         return FALSE;
1742     }
1743
1744     flags &= HEAP_NO_SERIALIZE;
1745     flags |= heapPtr->flags;
1746     if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1747
1748     /* Inform valgrind we are trying to free memory, so it can throw up an error message */
1749     notify_free( ptr );
1750
1751     /* Some sanity checks */
1752     pInUse  = (ARENA_INUSE *)ptr - 1;
1753     if (!validate_block_pointer( heapPtr, &subheap, pInUse )) goto error;
1754
1755     if (!subheap)
1756         free_large_block( heapPtr, flags, ptr );
1757     else
1758         HEAP_MakeInUseBlockFree( subheap, pInUse );
1759
1760     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1761     TRACE("(%p,%08x,%p): returning TRUE\n", heap, flags, ptr );
1762     return TRUE;
1763
1764 error:
1765     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1766     RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
1767     TRACE("(%p,%08x,%p): returning FALSE\n", heap, flags, ptr );
1768     return FALSE;
1769 }
1770
1771
1772 /***********************************************************************
1773  *           RtlReAllocateHeap   (NTDLL.@)
1774  *
1775  * Change the size of a memory block allocated with RtlAllocateHeap().
1776  *
1777  * PARAMS
1778  *  heap  [I] Heap that block was allocated from
1779  *  flags [I] HEAP_ flags from "winnt.h"
1780  *  ptr   [I] Block to resize
1781  *  size  [I] Size of the memory block to allocate
1782  *
1783  * RETURNS
1784  *  Success: A pointer to the resized block (which may be different).
1785  *  Failure: NULL.
1786  */
1787 PVOID WINAPI RtlReAllocateHeap( HANDLE heap, ULONG flags, PVOID ptr, SIZE_T size )
1788 {
1789     ARENA_INUSE *pArena;
1790     HEAP *heapPtr;
1791     SUBHEAP *subheap;
1792     SIZE_T oldBlockSize, oldActualSize, rounded_size;
1793     void *ret;
1794
1795     if (!ptr) return NULL;
1796     if (!(heapPtr = HEAP_GetPtr( heap )))
1797     {
1798         RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
1799         return NULL;
1800     }
1801
1802     /* Validate the parameters */
1803
1804     flags &= HEAP_GENERATE_EXCEPTIONS | HEAP_NO_SERIALIZE | HEAP_ZERO_MEMORY |
1805              HEAP_REALLOC_IN_PLACE_ONLY;
1806     flags |= heapPtr->flags;
1807     if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1808
1809     rounded_size = ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE(flags);
1810     if (rounded_size < size) goto oom;  /* overflow */
1811     if (rounded_size < HEAP_MIN_DATA_SIZE) rounded_size = HEAP_MIN_DATA_SIZE;
1812
1813     pArena = (ARENA_INUSE *)ptr - 1;
1814     if (!validate_block_pointer( heapPtr, &subheap, pArena )) goto error;
1815     if (!subheap)
1816     {
1817         if (!(ret = realloc_large_block( heapPtr, flags, ptr, size ))) goto oom;
1818         goto done;
1819     }
1820
1821     /* Check if we need to grow the block */
1822
1823     oldBlockSize = (pArena->size & ARENA_SIZE_MASK);
1824     oldActualSize = (pArena->size & ARENA_SIZE_MASK) - pArena->unused_bytes;
1825     if (rounded_size > oldBlockSize)
1826     {
1827         char *pNext = (char *)(pArena + 1) + oldBlockSize;
1828
1829         if (rounded_size >= HEAP_MIN_LARGE_BLOCK_SIZE && (flags & HEAP_GROWABLE))
1830         {
1831             if (flags & HEAP_REALLOC_IN_PLACE_ONLY) goto oom;
1832             if (!(ret = allocate_large_block( heapPtr, flags, size ))) goto oom;
1833             memcpy( ret, pArena + 1, oldActualSize );
1834             notify_free( pArena + 1 );
1835             HEAP_MakeInUseBlockFree( subheap, pArena );
1836             goto done;
1837         }
1838         if ((pNext < (char *)subheap->base + subheap->size) &&
1839             (*(DWORD *)pNext & ARENA_FLAG_FREE) &&
1840             (oldBlockSize + (*(DWORD *)pNext & ARENA_SIZE_MASK) + sizeof(ARENA_FREE) >= rounded_size))
1841         {
1842             /* The next block is free and large enough */
1843             ARENA_FREE *pFree = (ARENA_FREE *)pNext;
1844             list_remove( &pFree->entry );
1845             pArena->size += (pFree->size & ARENA_SIZE_MASK) + sizeof(*pFree);
1846             if (!HEAP_Commit( subheap, pArena, rounded_size )) goto oom;
1847             notify_free( pArena + 1 );
1848             HEAP_ShrinkBlock( subheap, pArena, rounded_size );
1849             notify_alloc( pArena + 1, size, FALSE );
1850             /* FIXME: this is wrong as we may lose old VBits settings */
1851             mark_block_initialized( pArena + 1, oldActualSize );
1852         }
1853         else  /* Do it the hard way */
1854         {
1855             ARENA_FREE *pNew;
1856             ARENA_INUSE *pInUse;
1857             SUBHEAP *newsubheap;
1858
1859             if ((flags & HEAP_REALLOC_IN_PLACE_ONLY) ||
1860                 !(pNew = HEAP_FindFreeBlock( heapPtr, rounded_size, &newsubheap )))
1861                 goto oom;
1862
1863             /* Build the in-use arena */
1864
1865             list_remove( &pNew->entry );
1866             pInUse = (ARENA_INUSE *)pNew;
1867             pInUse->size = (pInUse->size & ~ARENA_FLAG_FREE)
1868                            + sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
1869             pInUse->magic = ARENA_INUSE_MAGIC;
1870             HEAP_ShrinkBlock( newsubheap, pInUse, rounded_size );
1871
1872             mark_block_initialized( pInUse + 1, oldActualSize );
1873             notify_alloc( pInUse + 1, size, FALSE );
1874             memcpy( pInUse + 1, pArena + 1, oldActualSize );
1875
1876             /* Free the previous block */
1877
1878             notify_free( pArena + 1 );
1879             HEAP_MakeInUseBlockFree( subheap, pArena );
1880             subheap = newsubheap;
1881             pArena  = pInUse;
1882         }
1883     }
1884     else
1885     {
1886         /* Shrink the block */
1887         notify_free( pArena + 1 );
1888         HEAP_ShrinkBlock( subheap, pArena, rounded_size );
1889         notify_alloc( pArena + 1, size, FALSE );
1890         /* FIXME: this is wrong as we may lose old VBits settings */
1891         mark_block_initialized( pArena + 1, size );
1892     }
1893
1894     pArena->unused_bytes = (pArena->size & ARENA_SIZE_MASK) - size;
1895
1896     /* Clear the extra bytes if needed */
1897
1898     if (size > oldActualSize)
1899         initialize_block( (char *)(pArena + 1) + oldActualSize, size - oldActualSize,
1900                           pArena->unused_bytes, flags );
1901     else
1902         mark_block_tail( (char *)(pArena + 1) + size, pArena->unused_bytes, flags );
1903
1904     /* Return the new arena */
1905
1906     ret = pArena + 1;
1907 done:
1908     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1909     TRACE("(%p,%08x,%p,%08lx): returning %p\n", heap, flags, ptr, size, ret );
1910     return ret;
1911
1912 oom:
1913     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1914     if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1915     RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_NO_MEMORY );
1916     TRACE("(%p,%08x,%p,%08lx): returning NULL\n", heap, flags, ptr, size );
1917     return NULL;
1918
1919 error:
1920     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1921     RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
1922     TRACE("(%p,%08x,%p,%08lx): returning NULL\n", heap, flags, ptr, size );
1923     return NULL;
1924 }
1925
1926
1927 /***********************************************************************
1928  *           RtlCompactHeap   (NTDLL.@)
1929  *
1930  * Compact the free space in a Heap.
1931  *
1932  * PARAMS
1933  *  heap  [I] Heap that block was allocated from
1934  *  flags [I] HEAP_ flags from "winnt.h"
1935  *
1936  * RETURNS
1937  *  The number of bytes compacted.
1938  *
1939  * NOTES
1940  *  This function is a harmless stub.
1941  */
1942 ULONG WINAPI RtlCompactHeap( HANDLE heap, ULONG flags )
1943 {
1944     static BOOL reported;
1945     if (!reported++) FIXME( "(%p, 0x%x) stub\n", heap, flags );
1946     return 0;
1947 }
1948
1949
1950 /***********************************************************************
1951  *           RtlLockHeap   (NTDLL.@)
1952  *
1953  * Lock a Heap.
1954  *
1955  * PARAMS
1956  *  heap  [I] Heap to lock
1957  *
1958  * RETURNS
1959  *  Success: TRUE. The Heap is locked.
1960  *  Failure: FALSE, if heap is invalid.
1961  */
1962 BOOLEAN WINAPI RtlLockHeap( HANDLE heap )
1963 {
1964     HEAP *heapPtr = HEAP_GetPtr( heap );
1965     if (!heapPtr) return FALSE;
1966     RtlEnterCriticalSection( &heapPtr->critSection );
1967     return TRUE;
1968 }
1969
1970
1971 /***********************************************************************
1972  *           RtlUnlockHeap   (NTDLL.@)
1973  *
1974  * Unlock a Heap.
1975  *
1976  * PARAMS
1977  *  heap  [I] Heap to unlock
1978  *
1979  * RETURNS
1980  *  Success: TRUE. The Heap is unlocked.
1981  *  Failure: FALSE, if heap is invalid.
1982  */
1983 BOOLEAN WINAPI RtlUnlockHeap( HANDLE heap )
1984 {
1985     HEAP *heapPtr = HEAP_GetPtr( heap );
1986     if (!heapPtr) return FALSE;
1987     RtlLeaveCriticalSection( &heapPtr->critSection );
1988     return TRUE;
1989 }
1990
1991
1992 /***********************************************************************
1993  *           RtlSizeHeap   (NTDLL.@)
1994  *
1995  * Get the actual size of a memory block allocated from a Heap.
1996  *
1997  * PARAMS
1998  *  heap  [I] Heap that block was allocated from
1999  *  flags [I] HEAP_ flags from "winnt.h"
2000  *  ptr   [I] Block to get the size of
2001  *
2002  * RETURNS
2003  *  Success: The size of the block.
2004  *  Failure: -1, heap or ptr are invalid.
2005  *
2006  * NOTES
2007  *  The size may be bigger than what was passed to RtlAllocateHeap().
2008  */
2009 SIZE_T WINAPI RtlSizeHeap( HANDLE heap, ULONG flags, const void *ptr )
2010 {
2011     SIZE_T ret;
2012     const ARENA_INUSE *pArena;
2013     SUBHEAP *subheap;
2014     HEAP *heapPtr = HEAP_GetPtr( heap );
2015
2016     if (!heapPtr)
2017     {
2018         RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
2019         return ~0UL;
2020     }
2021     flags &= HEAP_NO_SERIALIZE;
2022     flags |= heapPtr->flags;
2023     if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
2024
2025     pArena = (const ARENA_INUSE *)ptr - 1;
2026     if (!validate_block_pointer( heapPtr, &subheap, pArena ))
2027     {
2028         RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
2029         ret = ~0UL;
2030     }
2031     else if (!subheap)
2032     {
2033         const ARENA_LARGE *large_arena = (const ARENA_LARGE *)ptr - 1;
2034         ret = large_arena->data_size;
2035     }
2036     else
2037     {
2038         ret = (pArena->size & ARENA_SIZE_MASK) - pArena->unused_bytes;
2039     }
2040     if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
2041
2042     TRACE("(%p,%08x,%p): returning %08lx\n", heap, flags, ptr, ret );
2043     return ret;
2044 }
2045
2046
2047 /***********************************************************************
2048  *           RtlValidateHeap   (NTDLL.@)
2049  *
2050  * Determine if a block is a valid allocation from a heap.
2051  *
2052  * PARAMS
2053  *  heap  [I] Heap that block was allocated from
2054  *  flags [I] HEAP_ flags from "winnt.h"
2055  *  ptr   [I] Block to check
2056  *
2057  * RETURNS
2058  *  Success: TRUE. The block was allocated from heap.
2059  *  Failure: FALSE, if heap is invalid or ptr was not allocated from it.
2060  */
2061 BOOLEAN WINAPI RtlValidateHeap( HANDLE heap, ULONG flags, LPCVOID ptr )
2062 {
2063     HEAP *heapPtr = HEAP_GetPtr( heap );
2064     if (!heapPtr) return FALSE;
2065     return HEAP_IsRealArena( heapPtr, flags, ptr, QUIET );
2066 }
2067
2068
2069 /***********************************************************************
2070  *           RtlWalkHeap    (NTDLL.@)
2071  *
2072  * FIXME
2073  *  The PROCESS_HEAP_ENTRY flag values seem different between this
2074  *  function and HeapWalk(). To be checked.
2075  */
2076 NTSTATUS WINAPI RtlWalkHeap( HANDLE heap, PVOID entry_ptr )
2077 {
2078     LPPROCESS_HEAP_ENTRY entry = entry_ptr; /* FIXME */
2079     HEAP *heapPtr = HEAP_GetPtr(heap);
2080     SUBHEAP *sub, *currentheap = NULL;
2081     NTSTATUS ret;
2082     char *ptr;
2083     int region_index = 0;
2084
2085     if (!heapPtr || !entry) return STATUS_INVALID_PARAMETER;
2086
2087     if (!(heapPtr->flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
2088
2089     /* FIXME: enumerate large blocks too */
2090
2091     /* set ptr to the next arena to be examined */
2092
2093     if (!entry->lpData) /* first call (init) ? */
2094     {
2095         TRACE("begin walking of heap %p.\n", heap);
2096         currentheap = &heapPtr->subheap;
2097         ptr = (char*)currentheap->base + currentheap->headerSize;
2098     }
2099     else
2100     {
2101         ptr = entry->lpData;
2102         LIST_FOR_EACH_ENTRY( sub, &heapPtr->subheap_list, SUBHEAP, entry )
2103         {
2104             if ((ptr >= (char *)sub->base) &&
2105                 (ptr < (char *)sub->base + sub->size))
2106             {
2107                 currentheap = sub;
2108                 break;
2109             }
2110             region_index++;
2111         }
2112         if (currentheap == NULL)
2113         {
2114             ERR("no matching subheap found, shouldn't happen !\n");
2115             ret = STATUS_NO_MORE_ENTRIES;
2116             goto HW_end;
2117         }
2118
2119         if (((ARENA_INUSE *)ptr - 1)->magic == ARENA_INUSE_MAGIC ||
2120             ((ARENA_INUSE *)ptr - 1)->magic == ARENA_PENDING_MAGIC)
2121         {
2122             ARENA_INUSE *pArena = (ARENA_INUSE *)ptr - 1;
2123             ptr += pArena->size & ARENA_SIZE_MASK;
2124         }
2125         else if (((ARENA_FREE *)ptr - 1)->magic == ARENA_FREE_MAGIC)
2126         {
2127             ARENA_FREE *pArena = (ARENA_FREE *)ptr - 1;
2128             ptr += pArena->size & ARENA_SIZE_MASK;
2129         }
2130         else
2131             ptr += entry->cbData; /* point to next arena */
2132
2133         if (ptr > (char *)currentheap->base + currentheap->size - 1)
2134         {   /* proceed with next subheap */
2135             struct list *next = list_next( &heapPtr->subheap_list, &currentheap->entry );
2136             if (!next)
2137             {  /* successfully finished */
2138                 TRACE("end reached.\n");
2139                 ret = STATUS_NO_MORE_ENTRIES;
2140                 goto HW_end;
2141             }
2142             currentheap = LIST_ENTRY( next, SUBHEAP, entry );
2143             ptr = (char *)currentheap->base + currentheap->headerSize;
2144         }
2145     }
2146
2147     entry->wFlags = 0;
2148     if (*(DWORD *)ptr & ARENA_FLAG_FREE)
2149     {
2150         ARENA_FREE *pArena = (ARENA_FREE *)ptr;
2151
2152         /*TRACE("free, magic: %04x\n", pArena->magic);*/
2153
2154         entry->lpData = pArena + 1;
2155         entry->cbData = pArena->size & ARENA_SIZE_MASK;
2156         entry->cbOverhead = sizeof(ARENA_FREE);
2157         entry->wFlags = PROCESS_HEAP_UNCOMMITTED_RANGE;
2158     }
2159     else
2160     {
2161         ARENA_INUSE *pArena = (ARENA_INUSE *)ptr;
2162
2163         /*TRACE("busy, magic: %04x\n", pArena->magic);*/
2164
2165         entry->lpData = pArena + 1;
2166         entry->cbData = pArena->size & ARENA_SIZE_MASK;
2167         entry->cbOverhead = sizeof(ARENA_INUSE);
2168         entry->wFlags = (pArena->magic == ARENA_PENDING_MAGIC) ?
2169                         PROCESS_HEAP_UNCOMMITTED_RANGE : PROCESS_HEAP_ENTRY_BUSY;
2170         /* FIXME: can't handle PROCESS_HEAP_ENTRY_MOVEABLE
2171         and PROCESS_HEAP_ENTRY_DDESHARE yet */
2172     }
2173
2174     entry->iRegionIndex = region_index;
2175
2176     /* first element of heap ? */
2177     if (ptr == (char *)currentheap->base + currentheap->headerSize)
2178     {
2179         entry->wFlags |= PROCESS_HEAP_REGION;
2180         entry->u.Region.dwCommittedSize = currentheap->commitSize;
2181         entry->u.Region.dwUnCommittedSize =
2182                 currentheap->size - currentheap->commitSize;
2183         entry->u.Region.lpFirstBlock = /* first valid block */
2184                 (char *)currentheap->base + currentheap->headerSize;
2185         entry->u.Region.lpLastBlock  = /* first invalid block */
2186                 (char *)currentheap->base + currentheap->size;
2187     }
2188     ret = STATUS_SUCCESS;
2189     if (TRACE_ON(heap)) HEAP_DumpEntry(entry);
2190
2191 HW_end:
2192     if (!(heapPtr->flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
2193     return ret;
2194 }
2195
2196
2197 /***********************************************************************
2198  *           RtlGetProcessHeaps    (NTDLL.@)
2199  *
2200  * Get the Heaps belonging to the current process.
2201  *
2202  * PARAMS
2203  *  count [I] size of heaps
2204  *  heaps [O] Destination array for heap HANDLE's
2205  *
2206  * RETURNS
2207  *  Success: The number of Heaps allocated by the process.
2208  *  Failure: 0.
2209  */
2210 ULONG WINAPI RtlGetProcessHeaps( ULONG count, HANDLE *heaps )
2211 {
2212     ULONG total = 1;  /* main heap */
2213     struct list *ptr;
2214
2215     RtlEnterCriticalSection( &processHeap->critSection );
2216     LIST_FOR_EACH( ptr, &processHeap->entry ) total++;
2217     if (total <= count)
2218     {
2219         *heaps++ = processHeap;
2220         LIST_FOR_EACH( ptr, &processHeap->entry )
2221             *heaps++ = LIST_ENTRY( ptr, HEAP, entry );
2222     }
2223     RtlLeaveCriticalSection( &processHeap->critSection );
2224     return total;
2225 }
2226
2227 /***********************************************************************
2228  *           RtlQueryHeapInformation    (NTDLL.@)
2229  */
2230 NTSTATUS WINAPI RtlQueryHeapInformation( HANDLE heap, HEAP_INFORMATION_CLASS info_class,
2231                                          PVOID info, SIZE_T size_in, PSIZE_T size_out)
2232 {
2233     switch (info_class)
2234     {
2235     case HeapCompatibilityInformation:
2236         if (size_out) *size_out = sizeof(ULONG);
2237
2238         if (size_in < sizeof(ULONG))
2239             return STATUS_BUFFER_TOO_SMALL;
2240
2241         *(ULONG *)info = 0; /* standard heap */
2242         return STATUS_SUCCESS;
2243
2244     default:
2245         FIXME("Unknown heap information class %u\n", info_class);
2246         return STATUS_INVALID_INFO_CLASS;
2247     }
2248 }