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