4 * Copyright 1996 Alexandre Julliard
5 * Copyright 1998 Ulrich Weigand
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.
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.
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
23 #include "wine/port.h"
30 #ifdef HAVE_VALGRIND_MEMCHECK_H
31 #include <valgrind/memcheck.h>
33 #define RUNNING_ON_VALGRIND 0
36 #define NONAMELESSUNION
37 #define NONAMELESSSTRUCT
39 #define WIN32_NO_STATUS
43 #include "wine/list.h"
44 #include "wine/debug.h"
45 #include "wine/server.h"
47 WINE_DEFAULT_DEBUG_CHANNEL(heap);
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.
54 typedef struct tagARENA_INUSE
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) */
61 typedef struct tagARENA_FREE
63 DWORD size; /* Block size; must be the first field */
64 DWORD magic; /* Magic number */
65 struct list entry; /* Entry in free list */
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 */
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 */
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
89 #define ARENA_INUSE_FILLER 0x55
90 #define ARENA_TAIL_FILLER 0xab
91 #define ARENA_FREE_FILLER 0xfeeefeee
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))
98 C_ASSERT( sizeof(ARENA_LARGE) % LARGE_ALIGNMENT == 0 );
100 #define ROUND_SIZE(size) ((((size) + ALIGNMENT - 1) & ~(ALIGNMENT-1)) + ARENA_OFFSET)
102 #define QUIET 1 /* Suppress messages */
103 #define NOISY 0 /* Report all errors */
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)
116 /* Max size of the blocks on the free lists */
117 static const SIZE_T HEAP_freeListSizes[] =
119 0x10, 0x20, 0x30, 0x40, 0x60, 0x80, 0x100, 0x200, 0x400, 0x1000, ~0UL
121 #define HEAP_NB_FREE_LISTS (sizeof(HEAP_freeListSizes)/sizeof(HEAP_freeListSizes[0]))
131 typedef struct tagSUBHEAP
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 */
143 #define SUBHEAP_MAGIC ((DWORD)('S' | ('U'<<8) | ('B'<<16) | ('H'<<24)))
145 typedef struct tagHEAP
147 DWORD_PTR unknown1[2];
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 */
163 #define HEAP_MAGIC ((DWORD)('H' | ('E'<<8) | ('A'<<16) | ('P'<<24)))
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 */
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
175 static HEAP *processHeap; /* main process heap */
177 static BOOL HEAP_IsRealArena( HEAP *heapPtr, DWORD flags, LPCVOID block, BOOL quiet );
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 )
182 if (flags & HEAP_FREE_CHECKING_ENABLED)
185 for (i = 0; i < size / sizeof(DWORD); i++) ((DWORD *)ptr)[i] = ARENA_FREE_FILLER;
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 ));
194 /* mark a block of memory as initialized for debugging purposes */
195 static inline void mark_block_initialized( void *ptr, SIZE_T size )
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 ));
204 /* mark a block of memory as uninitialized for debugging purposes */
205 static inline void mark_block_uninitialized( void *ptr, SIZE_T size )
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 ));
214 /* mark a block of memory as a tail block */
215 static inline void mark_block_tail( void *ptr, SIZE_T size, DWORD flags )
217 if (flags & HEAP_TAIL_CHECKING_ENABLED)
219 mark_block_uninitialized( ptr, size );
220 memset( ptr, ARENA_TAIL_FILLER, size );
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 ));
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 )
232 if (flags & HEAP_ZERO_MEMORY)
234 mark_block_initialized( ptr, size );
235 memset( ptr, 0, size );
239 mark_block_uninitialized( ptr, size );
240 if (flags & HEAP_FREE_CHECKING_ENABLED)
242 memset( ptr, ARENA_INUSE_FILLER, size );
243 mark_block_uninitialized( ptr, size );
247 mark_block_tail( (char *)ptr + size, unused, flags );
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 )
253 #ifdef VALGRIND_MALLOCLIKE_BLOCK
254 VALGRIND_MALLOCLIKE_BLOCK( ptr, size, 0, init );
258 /* notify that a block of memory has been freed for debugging purposes */
259 static inline void notify_free( void const *ptr )
261 #ifdef VALGRIND_FREELIKE_BLOCK
262 VALGRIND_FREELIKE_BLOCK( ptr, 0 );
266 static void subheap_notify_free_all(SUBHEAP const *subheap)
268 #ifdef VALGRIND_FREELIKE_BLOCK
269 char const *ptr = (char const *)subheap->base + subheap->headerSize;
271 if (!RUNNING_ON_VALGRIND) return;
273 while (ptr < (char const *)subheap->base + subheap->size)
275 if (*(const DWORD *)ptr & ARENA_FLAG_FREE)
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);
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);
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 )
298 size -= sizeof(ARENA_FREE);
299 for (i = 0; i < HEAP_NB_FREE_LISTS - 1; i++) if (size <= HEAP_freeListSizes[i]) break;
303 /* get the memory protection type to use for a given heap */
304 static inline ULONG get_protection_type( DWORD flags )
306 return (flags & HEAP_CREATE_ENABLE_EXECUTE) ? PAGE_EXECUTE_READWRITE : PAGE_READWRITE;
309 static RTL_CRITICAL_SECTION_DEBUG process_heap_critsect_debug =
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") }
317 /***********************************************************************
320 static void HEAP_Dump( HEAP *heap )
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 );
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 ));
337 LIST_FOR_EACH_ENTRY( subheap, &heap->subheap_list, SUBHEAP, entry )
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 );
343 DPRINTF( "\n Block Arena Stat Size Id\n" );
344 ptr = (char *)subheap->base + subheap->headerSize;
345 while (ptr < (char *)subheap->base + subheap->size)
347 if (*(DWORD *)ptr & ARENA_FLAG_FREE)
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;
359 else if (*(DWORD *)ptr & ARENA_FLAG_PREV_FREE)
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;
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;
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 );
386 static void HEAP_DumpEntry( LPPROCESS_HEAP_ENTRY entry )
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);
410 TRACE( "Unknown %08x", rem_flags);
412 if ((entry->wFlags & PROCESS_HEAP_ENTRY_BUSY )
413 && (entry->wFlags & PROCESS_HEAP_ENTRY_MOVEABLE))
416 TRACE( "BLOCK->hMem\t\t:%p\n", entry->u.Block.hMem);
418 if (entry->wFlags & PROCESS_HEAP_REGION)
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);
427 /***********************************************************************
430 * Pointer to the heap
433 static HEAP *HEAP_GetPtr(
434 HANDLE heap /* [in] Handle to the heap */
436 HEAP *heapPtr = heap;
437 if (!heapPtr || (heapPtr->magic != HEAP_MAGIC))
439 ERR("Invalid heap %p!\n", heap );
442 if ((heapPtr->flags & HEAP_VALIDATE_ALL) && !HEAP_IsRealArena( heapPtr, 0, NULL, NOISY ))
446 HEAP_Dump( heapPtr );
455 /***********************************************************************
456 * HEAP_InsertFreeBlock
458 * Insert a free block into the free list.
460 static inline void HEAP_InsertFreeBlock( HEAP *heap, ARENA_FREE *pArena, BOOL last )
462 FREE_LIST_ENTRY *pEntry = heap->freeList + get_freelist_index( pArena->size + sizeof(*pArena) );
465 /* insert at end of free list, i.e. before the next free list entry */
467 if (pEntry == &heap->freeList[HEAP_NB_FREE_LISTS]) pEntry = heap->freeList;
468 list_add_before( &pEntry->arena.entry, &pArena->entry );
472 /* insert at head of free list */
473 list_add_after( &pEntry->arena.entry, &pArena->entry );
475 pArena->size |= ARENA_FLAG_FREE;
479 /***********************************************************************
481 * Find the sub-heap containing a given address.
487 static SUBHEAP *HEAP_FindSubHeap(
488 const HEAP *heap, /* [in] Heap pointer */
489 LPCVOID ptr ) /* [in] Address */
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)))
500 /***********************************************************************
503 * Make sure the heap storage is committed for a given size in the specified arena.
505 static inline BOOL HEAP_Commit( SUBHEAP *subheap, ARENA_INUSE *pArena, SIZE_T data_size )
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 ) ))
517 WARN("Could not commit %08lx bytes at %p for heap %p\n",
518 size, ptr, subheap->heap );
521 subheap->commitSize += size;
526 /***********************************************************************
529 * If possible, decommit the heap storage from (including) 'ptr'.
531 static inline BOOL HEAP_Decommit( SUBHEAP *subheap, void *ptr )
534 SIZE_T decommit_size;
535 SIZE_T size = (char *)ptr - (char *)subheap->base;
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;
544 if (NtFreeVirtualMemory( NtCurrentProcess(), &addr, &decommit_size, MEM_DECOMMIT ))
546 WARN("Could not decommit %08lx bytes at %p for heap %p\n",
547 decommit_size, (char *)subheap->base + size, subheap->heap );
550 subheap->commitSize -= decommit_size;
555 /***********************************************************************
556 * HEAP_CreateFreeBlock
558 * Create a free block at a specified address. 'size' is the size of the
559 * whole block, including the new arena.
561 static void HEAP_CreateFreeBlock( SUBHEAP *subheap, void *ptr, SIZE_T size )
566 DWORD flags = subheap->heap->flags;
568 /* Create a free arena */
569 mark_block_uninitialized( ptr, sizeof(ARENA_FREE) );
571 pFree->magic = ARENA_FREE_MAGIC;
573 /* If debugging, erase the freed block content */
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 );
580 /* Check if next block is free also */
582 if (((char *)ptr + size < (char *)subheap->base + subheap->size) &&
583 (*(DWORD *)((char *)ptr + size) & ARENA_FLAG_FREE))
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 );
592 /* Set the next block PREV_FREE flag and pointer */
594 last = ((char *)ptr + size >= (char *)subheap->base + subheap->size);
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;
603 /* Last, insert the new block into the free list */
605 pFree->size = size - sizeof(*pFree);
606 HEAP_InsertFreeBlock( subheap->heap, pFree, last );
610 /***********************************************************************
611 * HEAP_MakeInUseBlockFree
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.
616 static void HEAP_MakeInUseBlockFree( SUBHEAP *subheap, ARENA_INUSE *pArena )
618 HEAP *heap = subheap->heap;
622 if (heap->pending_free)
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 );
631 subheap = HEAP_FindSubHeap( heap, pArena );
634 /* Check if we can merge with previous block */
636 size = (pArena->size & ARENA_SIZE_MASK) + sizeof(*pArena);
637 if (pArena->size & ARENA_FLAG_PREV_FREE)
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 );
644 else pFree = (ARENA_FREE *)pArena;
646 /* Create a free block */
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 */
653 /* Free the whole sub-heap if it's empty and not the original one */
655 if (((char *)pFree == (char *)subheap->base + subheap->headerSize) &&
656 (subheap != &subheap->heap->subheap))
659 void *addr = subheap->base;
660 /* Remove the free block from the list */
661 list_remove( &pFree->entry );
662 /* Remove the subheap from the list */
663 list_remove( &subheap->entry );
664 /* Free the memory */
666 NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
670 /* Decommit the end of the heap */
672 if (!(subheap->heap->flags & HEAP_SHARED)) HEAP_Decommit( subheap, pFree + 1 );
676 /***********************************************************************
679 * Shrink an in-use block.
681 static void HEAP_ShrinkBlock(SUBHEAP *subheap, ARENA_INUSE *pArena, SIZE_T size)
683 if ((pArena->size & ARENA_SIZE_MASK) >= size + HEAP_MIN_SHRINK_SIZE)
685 HEAP_CreateFreeBlock( subheap, (char *)(pArena + 1) + size,
686 (pArena->size & ARENA_SIZE_MASK) - size );
687 /* assign size plus previous arena flags */
688 pArena->size = size | (pArena->size & ~ARENA_SIZE_MASK);
692 /* Turn off PREV_FREE flag in next block */
693 char *pNext = (char *)(pArena + 1) + (pArena->size & ARENA_SIZE_MASK);
694 if (pNext < (char *)subheap->base + subheap->size)
695 *(DWORD *)pNext &= ~ARENA_FLAG_PREV_FREE;
700 /***********************************************************************
701 * allocate_large_block
703 static void *allocate_large_block( HEAP *heap, DWORD flags, SIZE_T size )
706 SIZE_T block_size = sizeof(*arena) + ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE(flags);
707 LPVOID address = NULL;
709 if (block_size < size) return NULL; /* overflow */
710 if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 5,
711 &block_size, MEM_COMMIT, get_protection_type( flags ) ))
713 WARN("Could not allocate block for %08lx bytes\n", size );
717 arena->data_size = size;
718 arena->block_size = block_size;
719 arena->size = ARENA_LARGE_SIZE;
720 arena->magic = ARENA_LARGE_MAGIC;
721 mark_block_tail( (char *)(arena + 1) + size, block_size - sizeof(*arena) - size, flags );
722 list_add_tail( &heap->large_list, &arena->entry );
723 notify_alloc( arena + 1, size, flags & HEAP_ZERO_MEMORY );
728 /***********************************************************************
731 static void free_large_block( HEAP *heap, DWORD flags, void *ptr )
733 ARENA_LARGE *arena = (ARENA_LARGE *)ptr - 1;
734 LPVOID address = arena;
737 list_remove( &arena->entry );
738 NtFreeVirtualMemory( NtCurrentProcess(), &address, &size, MEM_RELEASE );
742 /***********************************************************************
743 * realloc_large_block
745 static void *realloc_large_block( HEAP *heap, DWORD flags, void *ptr, SIZE_T size )
747 ARENA_LARGE *arena = (ARENA_LARGE *)ptr - 1;
750 if (arena->block_size - sizeof(*arena) >= size)
752 SIZE_T unused = arena->block_size - sizeof(*arena) - size;
754 /* FIXME: we could remap zero-pages instead */
755 if (size > arena->data_size)
756 initialize_block( (char *)ptr + arena->data_size, size - arena->data_size, unused, flags );
758 mark_block_tail( (char *)ptr + size, unused, flags );
759 arena->data_size = size;
762 if (flags & HEAP_REALLOC_IN_PLACE_ONLY) return NULL;
763 if (!(new_ptr = allocate_large_block( heap, flags, size )))
765 WARN("Could not allocate block for %08lx bytes\n", size );
768 memcpy( new_ptr, ptr, arena->data_size );
769 free_large_block( heap, flags, ptr );
775 /***********************************************************************
778 static ARENA_LARGE *find_large_block( HEAP *heap, const void *ptr )
782 LIST_FOR_EACH_ENTRY( arena, &heap->large_list, ARENA_LARGE, entry )
783 if (ptr == arena + 1) return arena;
789 /***********************************************************************
790 * validate_large_arena
792 static BOOL validate_large_arena( HEAP *heap, const ARENA_LARGE *arena, BOOL quiet )
794 DWORD flags = heap->flags;
796 if ((ULONG_PTR)arena % getpagesize())
800 ERR( "Heap %p: invalid large arena pointer %p\n", heap, arena );
801 if (TRACE_ON(heap)) HEAP_Dump( heap );
803 else if (WARN_ON(heap))
805 WARN( "Heap %p: unaligned arena pointer %p\n", heap, arena );
806 if (TRACE_ON(heap)) HEAP_Dump( heap );
810 if (arena->size != ARENA_LARGE_SIZE || arena->magic != ARENA_LARGE_MAGIC)
814 ERR( "Heap %p: invalid large arena %p values %x/%x\n",
815 heap, arena, arena->size, arena->magic );
816 if (TRACE_ON(heap)) HEAP_Dump( heap );
818 else if (WARN_ON(heap))
820 WARN( "Heap %p: invalid large arena %p values %x/%x\n",
821 heap, arena, arena->size, arena->magic );
822 if (TRACE_ON(heap)) HEAP_Dump( heap );
826 if (arena->data_size > arena->block_size - sizeof(*arena))
828 ERR( "Heap %p: invalid large arena %p size %lx/%lx\n",
829 heap, arena, arena->data_size, arena->block_size );
832 if (flags & HEAP_TAIL_CHECKING_ENABLED)
834 SIZE_T i, unused = arena->block_size - sizeof(*arena) - arena->data_size;
835 const unsigned char *data = (const unsigned char *)(arena + 1) + arena->data_size;
837 for (i = 0; i < unused; i++)
839 if (data[i] == ARENA_TAIL_FILLER) continue;
840 ERR("Heap %p: block %p tail overwritten at %p (byte %lu/%lu == 0x%02x)\n",
841 heap, arena + 1, data + i, i, unused, data[i] );
849 /***********************************************************************
852 static SUBHEAP *HEAP_CreateSubHeap( HEAP *heap, LPVOID address, DWORD flags,
853 SIZE_T commitSize, SIZE_T totalSize )
856 FREE_LIST_ENTRY *pEntry;
861 if (!commitSize) commitSize = COMMIT_MASK + 1;
862 totalSize = min( totalSize, 0xffff0000 ); /* don't allow a heap larger than 4Gb */
863 if (totalSize < commitSize) totalSize = commitSize;
864 if (flags & HEAP_SHARED) commitSize = totalSize; /* always commit everything in a shared heap */
866 /* allocate the memory block */
867 if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 5, &totalSize,
868 MEM_RESERVE, get_protection_type( flags ) ))
870 WARN("Could not allocate %08lx bytes\n", totalSize );
873 if (NtAllocateVirtualMemory( NtCurrentProcess(), &address, 0,
874 &commitSize, MEM_COMMIT, get_protection_type( flags ) ))
876 WARN("Could not commit %08lx bytes for sub-heap %p\n", commitSize, address );
883 /* If this is a secondary subheap, insert it into list */
886 subheap->base = address;
887 subheap->heap = heap;
888 subheap->size = totalSize;
889 subheap->min_commit = 0x10000;
890 subheap->commitSize = commitSize;
891 subheap->magic = SUBHEAP_MAGIC;
892 subheap->headerSize = ROUND_SIZE( sizeof(SUBHEAP) );
893 list_add_head( &heap->subheap_list, &subheap->entry );
897 /* If this is a primary subheap, initialize main heap */
901 heap->magic = HEAP_MAGIC;
902 heap->grow_size = max( HEAP_DEF_SIZE, totalSize );
903 list_init( &heap->subheap_list );
904 list_init( &heap->large_list );
906 subheap = &heap->subheap;
907 subheap->base = address;
908 subheap->heap = heap;
909 subheap->size = totalSize;
910 subheap->min_commit = commitSize;
911 subheap->commitSize = commitSize;
912 subheap->magic = SUBHEAP_MAGIC;
913 subheap->headerSize = ROUND_SIZE( sizeof(HEAP) );
914 list_add_head( &heap->subheap_list, &subheap->entry );
916 /* Build the free lists */
918 heap->freeList = (FREE_LIST_ENTRY *)((char *)heap + subheap->headerSize);
919 subheap->headerSize += HEAP_NB_FREE_LISTS * sizeof(FREE_LIST_ENTRY);
920 list_init( &heap->freeList[0].arena.entry );
921 for (i = 0, pEntry = heap->freeList; i < HEAP_NB_FREE_LISTS; i++, pEntry++)
923 pEntry->arena.size = 0 | ARENA_FLAG_FREE;
924 pEntry->arena.magic = ARENA_FREE_MAGIC;
925 if (i) list_add_after( &pEntry[-1].arena.entry, &pEntry->arena.entry );
928 /* Initialize critical section */
930 if (!processHeap) /* do it by hand to avoid memory allocations */
932 heap->critSection.DebugInfo = &process_heap_critsect_debug;
933 heap->critSection.LockCount = -1;
934 heap->critSection.RecursionCount = 0;
935 heap->critSection.OwningThread = 0;
936 heap->critSection.LockSemaphore = 0;
937 heap->critSection.SpinCount = 0;
938 process_heap_critsect_debug.CriticalSection = &heap->critSection;
942 RtlInitializeCriticalSection( &heap->critSection );
943 heap->critSection.DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": HEAP.critSection");
946 if (flags & HEAP_SHARED)
948 /* let's assume that only one thread at a time will try to do this */
949 HANDLE sem = heap->critSection.LockSemaphore;
950 if (!sem) NtCreateSemaphore( &sem, SEMAPHORE_ALL_ACCESS, NULL, 0, 1 );
952 NtDuplicateObject( NtCurrentProcess(), sem, NtCurrentProcess(), &sem, 0, 0,
953 DUP_HANDLE_MAKE_GLOBAL | DUP_HANDLE_SAME_ACCESS | DUP_HANDLE_CLOSE_SOURCE );
954 heap->critSection.LockSemaphore = sem;
955 RtlFreeHeap( processHeap, 0, heap->critSection.DebugInfo );
956 heap->critSection.DebugInfo = NULL;
960 /* Create the first free block */
962 HEAP_CreateFreeBlock( subheap, (LPBYTE)subheap->base + subheap->headerSize,
963 subheap->size - subheap->headerSize );
969 /***********************************************************************
972 * Find a free block at least as large as the requested size, and make sure
973 * the requested size is committed.
975 static ARENA_FREE *HEAP_FindFreeBlock( HEAP *heap, SIZE_T size,
976 SUBHEAP **ppSubHeap )
981 FREE_LIST_ENTRY *pEntry = heap->freeList + get_freelist_index( size + sizeof(ARENA_INUSE) );
983 /* Find a suitable free list, and in it find a block large enough */
985 ptr = &pEntry->arena.entry;
986 while ((ptr = list_next( &heap->freeList[0].arena.entry, ptr )))
988 ARENA_FREE *pArena = LIST_ENTRY( ptr, ARENA_FREE, entry );
989 SIZE_T arena_size = (pArena->size & ARENA_SIZE_MASK) +
990 sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
991 if (arena_size >= size)
993 subheap = HEAP_FindSubHeap( heap, pArena );
994 if (!HEAP_Commit( subheap, (ARENA_INUSE *)pArena, size )) return NULL;
995 *ppSubHeap = subheap;
1000 /* If no block was found, attempt to grow the heap */
1002 if (!(heap->flags & HEAP_GROWABLE))
1004 WARN("Not enough space in heap %p for %08lx bytes\n", heap, size );
1007 /* make sure that we have a big enough size *committed* to fit another
1008 * last free arena in !
1009 * So just one heap struct, one first free arena which will eventually
1010 * get used, and a second free arena that might get assigned all remaining
1011 * free space in HEAP_ShrinkBlock() */
1012 total_size = size + ROUND_SIZE(sizeof(SUBHEAP)) + sizeof(ARENA_INUSE) + sizeof(ARENA_FREE);
1013 if (total_size < size) return NULL; /* overflow */
1015 if ((subheap = HEAP_CreateSubHeap( heap, NULL, heap->flags, total_size,
1016 max( heap->grow_size, total_size ) )))
1018 if (heap->grow_size < 128 * 1024 * 1024) heap->grow_size *= 2;
1020 else while (!subheap) /* shrink the grow size again if we are running out of space */
1022 if (heap->grow_size <= total_size || heap->grow_size <= 4 * 1024 * 1024) return NULL;
1023 heap->grow_size /= 2;
1024 subheap = HEAP_CreateSubHeap( heap, NULL, heap->flags, total_size,
1025 max( heap->grow_size, total_size ) );
1028 TRACE("created new sub-heap %p of %08lx bytes for heap %p\n",
1029 subheap, subheap->size, heap );
1031 *ppSubHeap = subheap;
1032 return (ARENA_FREE *)((char *)subheap->base + subheap->headerSize);
1036 /***********************************************************************
1037 * HEAP_IsValidArenaPtr
1039 * Check that the pointer is inside the range possible for arenas.
1041 static BOOL HEAP_IsValidArenaPtr( const HEAP *heap, const ARENA_FREE *ptr )
1044 const SUBHEAP *subheap = HEAP_FindSubHeap( heap, ptr );
1045 if (!subheap) return FALSE;
1046 if ((const char *)ptr >= (const char *)subheap->base + subheap->headerSize) return TRUE;
1047 if (subheap != &heap->subheap) return FALSE;
1048 for (i = 0; i < HEAP_NB_FREE_LISTS; i++)
1049 if (ptr == &heap->freeList[i].arena) return TRUE;
1054 /***********************************************************************
1055 * HEAP_ValidateFreeArena
1057 static BOOL HEAP_ValidateFreeArena( SUBHEAP *subheap, ARENA_FREE *pArena )
1059 DWORD flags = subheap->heap->flags;
1061 ARENA_FREE *prev, *next;
1062 char *heapEnd = (char *)subheap->base + subheap->size;
1064 /* Check for unaligned pointers */
1065 if ((ULONG_PTR)pArena % ALIGNMENT != ARENA_OFFSET)
1067 ERR("Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1071 /* Check magic number */
1072 if (pArena->magic != ARENA_FREE_MAGIC)
1074 ERR("Heap %p: invalid free arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1077 /* Check size flags */
1078 if (!(pArena->size & ARENA_FLAG_FREE) ||
1079 (pArena->size & ARENA_FLAG_PREV_FREE))
1081 ERR("Heap %p: bad flags %08x for free arena %p\n",
1082 subheap->heap, pArena->size & ~ARENA_SIZE_MASK, pArena );
1085 /* Check arena size */
1086 size = pArena->size & ARENA_SIZE_MASK;
1087 if ((char *)(pArena + 1) + size > heapEnd)
1089 ERR("Heap %p: bad size %08lx for free arena %p\n", subheap->heap, size, pArena );
1092 /* Check that next pointer is valid */
1093 next = LIST_ENTRY( pArena->entry.next, ARENA_FREE, entry );
1094 if (!HEAP_IsValidArenaPtr( subheap->heap, next ))
1096 ERR("Heap %p: bad next ptr %p for arena %p\n",
1097 subheap->heap, next, pArena );
1100 /* Check that next arena is free */
1101 if (!(next->size & ARENA_FLAG_FREE) || (next->magic != ARENA_FREE_MAGIC))
1103 ERR("Heap %p: next arena %p invalid for %p\n",
1104 subheap->heap, next, pArena );
1107 /* Check that prev pointer is valid */
1108 prev = LIST_ENTRY( pArena->entry.prev, ARENA_FREE, entry );
1109 if (!HEAP_IsValidArenaPtr( subheap->heap, prev ))
1111 ERR("Heap %p: bad prev ptr %p for arena %p\n",
1112 subheap->heap, prev, pArena );
1115 /* Check that prev arena is free */
1116 if (!(prev->size & ARENA_FLAG_FREE) || (prev->magic != ARENA_FREE_MAGIC))
1118 /* this often means that the prev arena got overwritten
1119 * by a memory write before that prev arena */
1120 ERR("Heap %p: prev arena %p invalid for %p\n",
1121 subheap->heap, prev, pArena );
1124 /* Check that next block has PREV_FREE flag */
1125 if ((char *)(pArena + 1) + size < heapEnd)
1127 if (!(*(DWORD *)((char *)(pArena + 1) + size) & ARENA_FLAG_PREV_FREE))
1129 ERR("Heap %p: free arena %p next block has no PREV_FREE flag\n",
1130 subheap->heap, pArena );
1133 /* Check next block back pointer */
1134 if (*((ARENA_FREE **)((char *)(pArena + 1) + size) - 1) != pArena)
1136 ERR("Heap %p: arena %p has wrong back ptr %p\n",
1137 subheap->heap, pArena,
1138 *((ARENA_FREE **)((char *)(pArena+1) + size) - 1));
1142 if (flags & HEAP_FREE_CHECKING_ENABLED)
1144 DWORD *ptr = (DWORD *)(pArena + 1);
1145 char *end = (char *)(pArena + 1) + size;
1147 if (end >= heapEnd) end = (char *)subheap->base + subheap->commitSize;
1148 else end -= sizeof(ARENA_FREE *);
1149 while (ptr < (DWORD *)end)
1151 if (*ptr != ARENA_FREE_FILLER)
1153 ERR("Heap %p: free block %p overwritten at %p by %08x\n",
1154 subheap->heap, (ARENA_INUSE *)pArena + 1, ptr, *ptr );
1164 /***********************************************************************
1165 * HEAP_ValidateInUseArena
1167 static BOOL HEAP_ValidateInUseArena( const SUBHEAP *subheap, const ARENA_INUSE *pArena, BOOL quiet )
1170 DWORD i, flags = subheap->heap->flags;
1171 const char *heapEnd = (const char *)subheap->base + subheap->size;
1173 /* Check for unaligned pointers */
1174 if ((ULONG_PTR)pArena % ALIGNMENT != ARENA_OFFSET)
1176 if ( quiet == NOISY )
1178 ERR( "Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1179 if ( TRACE_ON(heap) )
1180 HEAP_Dump( subheap->heap );
1182 else if ( WARN_ON(heap) )
1184 WARN( "Heap %p: unaligned arena pointer %p\n", subheap->heap, pArena );
1185 if ( TRACE_ON(heap) )
1186 HEAP_Dump( subheap->heap );
1191 /* Check magic number */
1192 if (pArena->magic != ARENA_INUSE_MAGIC && pArena->magic != ARENA_PENDING_MAGIC)
1194 if (quiet == NOISY) {
1195 ERR("Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1197 HEAP_Dump( subheap->heap );
1198 } else if (WARN_ON(heap)) {
1199 WARN("Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, pArena->magic, pArena );
1201 HEAP_Dump( subheap->heap );
1205 /* Check size flags */
1206 if (pArena->size & ARENA_FLAG_FREE)
1208 ERR("Heap %p: bad flags %08x for in-use arena %p\n",
1209 subheap->heap, pArena->size & ~ARENA_SIZE_MASK, pArena );
1212 /* Check arena size */
1213 size = pArena->size & ARENA_SIZE_MASK;
1214 if ((const char *)(pArena + 1) + size > heapEnd ||
1215 (const char *)(pArena + 1) + size < (const char *)(pArena + 1))
1217 ERR("Heap %p: bad size %08lx for in-use arena %p\n", subheap->heap, size, pArena );
1220 /* Check next arena PREV_FREE flag */
1221 if (((const char *)(pArena + 1) + size < heapEnd) &&
1222 (*(const DWORD *)((const char *)(pArena + 1) + size) & ARENA_FLAG_PREV_FREE))
1224 ERR("Heap %p: in-use arena %p next block %p has PREV_FREE flag %x\n",
1225 subheap->heap, pArena, (const char *)(pArena + 1) + size,*(const DWORD *)((const char *)(pArena + 1) + size) );
1228 /* Check prev free arena */
1229 if (pArena->size & ARENA_FLAG_PREV_FREE)
1231 const ARENA_FREE *pPrev = *((const ARENA_FREE * const*)pArena - 1);
1232 /* Check prev pointer */
1233 if (!HEAP_IsValidArenaPtr( subheap->heap, pPrev ))
1235 ERR("Heap %p: bad back ptr %p for arena %p\n",
1236 subheap->heap, pPrev, pArena );
1239 /* Check that prev arena is free */
1240 if (!(pPrev->size & ARENA_FLAG_FREE) ||
1241 (pPrev->magic != ARENA_FREE_MAGIC))
1243 ERR("Heap %p: prev arena %p invalid for in-use %p\n",
1244 subheap->heap, pPrev, pArena );
1247 /* Check that prev arena is really the previous block */
1248 if ((const char *)(pPrev + 1) + (pPrev->size & ARENA_SIZE_MASK) != (const char *)pArena)
1250 ERR("Heap %p: prev arena %p is not prev for in-use %p\n",
1251 subheap->heap, pPrev, pArena );
1255 /* Check unused size */
1256 if (pArena->unused_bytes > size)
1258 ERR("Heap %p: invalid unused size %08x/%08lx\n", subheap->heap, pArena->unused_bytes, size );
1261 /* Check unused bytes */
1262 if (pArena->magic == ARENA_PENDING_MAGIC)
1264 DWORD *ptr = (DWORD *)(pArena + 1);
1265 DWORD *end = (DWORD *)((char *)ptr + size);
1269 if (*ptr != ARENA_FREE_FILLER)
1271 ERR("Heap %p: free block %p overwritten at %p by %08x\n",
1272 subheap->heap, (ARENA_INUSE *)pArena + 1, ptr, *ptr );
1273 if (!*ptr) { HEAP_Dump( subheap->heap ); DbgBreakPoint(); }
1279 else if (flags & HEAP_TAIL_CHECKING_ENABLED)
1281 const unsigned char *data = (const unsigned char *)(pArena + 1) + size - pArena->unused_bytes;
1283 for (i = 0; i < pArena->unused_bytes; i++)
1285 if (data[i] == ARENA_TAIL_FILLER) continue;
1286 ERR("Heap %p: block %p tail overwritten at %p (byte %u/%u == 0x%02x)\n",
1287 subheap->heap, pArena + 1, data + i, i, pArena->unused_bytes, data[i] );
1295 /***********************************************************************
1296 * HEAP_IsRealArena [Internal]
1297 * Validates a block is a valid arena.
1303 static BOOL HEAP_IsRealArena( HEAP *heapPtr, /* [in] ptr to the heap */
1304 DWORD flags, /* [in] Bit flags that control access during operation */
1305 LPCVOID block, /* [in] Optional pointer to memory block to validate */
1306 BOOL quiet ) /* [in] Flag - if true, HEAP_ValidateInUseArena
1307 * does not complain */
1311 const ARENA_LARGE *large_arena;
1313 flags &= HEAP_NO_SERIALIZE;
1314 flags |= heapPtr->flags;
1315 /* calling HeapLock may result in infinite recursion, so do the critsect directly */
1316 if (!(flags & HEAP_NO_SERIALIZE))
1317 RtlEnterCriticalSection( &heapPtr->critSection );
1319 if (block) /* only check this single memory block */
1321 const ARENA_INUSE *arena = (const ARENA_INUSE *)block - 1;
1323 if (!(subheap = HEAP_FindSubHeap( heapPtr, arena )) ||
1324 ((const char *)arena < (char *)subheap->base + subheap->headerSize))
1326 if (!(large_arena = find_large_block( heapPtr, block )))
1329 ERR("Heap %p: block %p is not inside heap\n", heapPtr, block );
1330 else if (WARN_ON(heap))
1331 WARN("Heap %p: block %p is not inside heap\n", heapPtr, block );
1335 ret = validate_large_arena( heapPtr, large_arena, quiet );
1337 ret = HEAP_ValidateInUseArena( subheap, arena, quiet );
1339 if (!(flags & HEAP_NO_SERIALIZE))
1340 RtlLeaveCriticalSection( &heapPtr->critSection );
1344 LIST_FOR_EACH_ENTRY( subheap, &heapPtr->subheap_list, SUBHEAP, entry )
1346 char *ptr = (char *)subheap->base + subheap->headerSize;
1347 while (ptr < (char *)subheap->base + subheap->size)
1349 if (*(DWORD *)ptr & ARENA_FLAG_FREE)
1351 if (!HEAP_ValidateFreeArena( subheap, (ARENA_FREE *)ptr )) {
1355 ptr += sizeof(ARENA_FREE) + (*(DWORD *)ptr & ARENA_SIZE_MASK);
1359 if (!HEAP_ValidateInUseArena( subheap, (ARENA_INUSE *)ptr, NOISY )) {
1363 ptr += sizeof(ARENA_INUSE) + (*(DWORD *)ptr & ARENA_SIZE_MASK);
1369 LIST_FOR_EACH_ENTRY( large_arena, &heapPtr->large_list, ARENA_LARGE, entry )
1370 if (!(ret = validate_large_arena( heapPtr, large_arena, quiet ))) break;
1372 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1377 /***********************************************************************
1378 * validate_block_pointer
1380 * Minimum validation needed to catch bad parameters in heap functions.
1382 static BOOL validate_block_pointer( HEAP *heap, SUBHEAP **ret_subheap, const ARENA_INUSE *arena )
1387 if (!(*ret_subheap = subheap = HEAP_FindSubHeap( heap, arena )))
1389 ARENA_LARGE *large_arena = find_large_block( heap, arena + 1 );
1393 WARN( "Heap %p: pointer %p is not inside heap\n", heap, arena + 1 );
1396 if ((heap->flags & HEAP_VALIDATE) && !validate_large_arena( heap, large_arena, QUIET ))
1401 if ((char *)arena < (char *)subheap->base + subheap->headerSize)
1402 WARN( "Heap %p: pointer %p is inside subheap %p header\n", subheap->heap, arena + 1, subheap );
1403 else if (subheap->heap->flags & HEAP_VALIDATE) /* do the full validation */
1404 ret = HEAP_ValidateInUseArena( subheap, arena, QUIET );
1405 else if ((ULONG_PTR)arena % ALIGNMENT != ARENA_OFFSET)
1406 WARN( "Heap %p: unaligned arena pointer %p\n", subheap->heap, arena );
1407 else if (arena->magic == ARENA_PENDING_MAGIC)
1408 WARN( "Heap %p: block %p used after free\n", subheap->heap, arena + 1 );
1409 else if (arena->magic != ARENA_INUSE_MAGIC)
1410 WARN( "Heap %p: invalid in-use arena magic %08x for %p\n", subheap->heap, arena->magic, arena );
1411 else if (arena->size & ARENA_FLAG_FREE)
1412 ERR( "Heap %p: bad flags %08x for in-use arena %p\n",
1413 subheap->heap, arena->size & ~ARENA_SIZE_MASK, arena );
1414 else if ((const char *)(arena + 1) + (arena->size & ARENA_SIZE_MASK) > (const char *)subheap->base + subheap->size ||
1415 (const char *)(arena + 1) + (arena->size & ARENA_SIZE_MASK) < (const char *)(arena + 1))
1416 ERR( "Heap %p: bad size %08x for in-use arena %p\n",
1417 subheap->heap, arena->size & ARENA_SIZE_MASK, arena );
1425 /***********************************************************************
1426 * heap_set_debug_flags
1428 void heap_set_debug_flags( HANDLE handle )
1430 HEAP *heap = HEAP_GetPtr( handle );
1431 ULONG global_flags = RtlGetNtGlobalFlags();
1434 if (TRACE_ON(heap)) global_flags |= FLG_HEAP_VALIDATE_ALL;
1435 if (WARN_ON(heap)) global_flags |= FLG_HEAP_VALIDATE_PARAMETERS;
1437 if (global_flags & FLG_HEAP_ENABLE_TAIL_CHECK) flags |= HEAP_TAIL_CHECKING_ENABLED;
1438 if (global_flags & FLG_HEAP_ENABLE_FREE_CHECK) flags |= HEAP_FREE_CHECKING_ENABLED;
1439 if (global_flags & FLG_HEAP_DISABLE_COALESCING) flags |= HEAP_DISABLE_COALESCE_ON_FREE;
1440 if (global_flags & FLG_HEAP_PAGE_ALLOCS) flags |= HEAP_PAGE_ALLOCS | HEAP_GROWABLE;
1442 if (global_flags & FLG_HEAP_VALIDATE_PARAMETERS)
1443 flags |= HEAP_VALIDATE | HEAP_VALIDATE_PARAMS |
1444 HEAP_TAIL_CHECKING_ENABLED | HEAP_FREE_CHECKING_ENABLED;
1445 if (global_flags & FLG_HEAP_VALIDATE_ALL)
1446 flags |= HEAP_VALIDATE | HEAP_VALIDATE_ALL |
1447 HEAP_TAIL_CHECKING_ENABLED | HEAP_FREE_CHECKING_ENABLED;
1449 if (RUNNING_ON_VALGRIND) flags = 0; /* no sense in validating since Valgrind catches accesses */
1451 heap->flags |= flags;
1452 heap->force_flags |= flags & ~(HEAP_VALIDATE | HEAP_DISABLE_COALESCE_ON_FREE);
1454 if (flags & (HEAP_FREE_CHECKING_ENABLED | HEAP_TAIL_CHECKING_ENABLED)) /* fix existing blocks */
1459 LIST_FOR_EACH_ENTRY( subheap, &heap->subheap_list, SUBHEAP, entry )
1461 char *ptr = (char *)subheap->base + subheap->headerSize;
1462 char *end = (char *)subheap->base + subheap->commitSize;
1465 ARENA_INUSE *arena = (ARENA_INUSE *)ptr;
1466 SIZE_T size = arena->size & ARENA_SIZE_MASK;
1467 if (arena->size & ARENA_FLAG_FREE)
1469 SIZE_T count = size;
1471 ptr += sizeof(ARENA_FREE) + size;
1472 if (ptr >= end) count = end - (char *)((ARENA_FREE *)arena + 1);
1473 else count -= sizeof(ARENA_FREE *);
1474 mark_block_free( (ARENA_FREE *)arena + 1, count, flags );
1478 if (arena->magic == ARENA_PENDING_MAGIC)
1479 mark_block_free( arena + 1, size, flags );
1481 mark_block_tail( (char *)(arena + 1) + size - arena->unused_bytes,
1482 arena->unused_bytes, flags );
1483 ptr += sizeof(ARENA_INUSE) + size;
1488 LIST_FOR_EACH_ENTRY( large, &heap->large_list, ARENA_LARGE, entry )
1489 mark_block_tail( (char *)(large + 1) + large->data_size,
1490 large->block_size - sizeof(*large) - large->data_size, flags );
1493 if ((heap->flags & HEAP_GROWABLE) && !heap->pending_free &&
1494 ((flags & HEAP_FREE_CHECKING_ENABLED) || RUNNING_ON_VALGRIND))
1497 SIZE_T size = MAX_FREE_PENDING * sizeof(*heap->pending_free);
1499 if (!NtAllocateVirtualMemory( NtCurrentProcess(), &ptr, 4, &size, MEM_COMMIT, PAGE_READWRITE ))
1501 heap->pending_free = ptr;
1502 heap->pending_pos = 0;
1508 /***********************************************************************
1509 * RtlCreateHeap (NTDLL.@)
1511 * Create a new Heap.
1514 * flags [I] HEAP_ flags from "winnt.h"
1515 * addr [I] Desired base address
1516 * totalSize [I] Total size of the heap, or 0 for a growable heap
1517 * commitSize [I] Amount of heap space to commit
1518 * unknown [I] Not yet understood
1519 * definition [I] Heap definition
1522 * Success: A HANDLE to the newly created heap.
1523 * Failure: a NULL HANDLE.
1525 HANDLE WINAPI RtlCreateHeap( ULONG flags, PVOID addr, SIZE_T totalSize, SIZE_T commitSize,
1526 PVOID unknown, PRTL_HEAP_DEFINITION definition )
1530 /* Allocate the heap block */
1534 totalSize = HEAP_DEF_SIZE;
1535 flags |= HEAP_GROWABLE;
1538 if (!(subheap = HEAP_CreateSubHeap( NULL, addr, flags, commitSize, totalSize ))) return 0;
1540 /* link it into the per-process heap list */
1543 HEAP *heapPtr = subheap->heap;
1544 RtlEnterCriticalSection( &processHeap->critSection );
1545 list_add_head( &processHeap->entry, &heapPtr->entry );
1546 RtlLeaveCriticalSection( &processHeap->critSection );
1550 processHeap = subheap->heap; /* assume the first heap we create is the process main heap */
1551 list_init( &processHeap->entry );
1554 heap_set_debug_flags( subheap->heap );
1555 return subheap->heap;
1559 /***********************************************************************
1560 * RtlDestroyHeap (NTDLL.@)
1562 * Destroy a Heap created with RtlCreateHeap().
1565 * heap [I] Heap to destroy.
1568 * Success: A NULL HANDLE, if heap is NULL or it was destroyed
1569 * Failure: The Heap handle, if heap is the process heap.
1571 HANDLE WINAPI RtlDestroyHeap( HANDLE heap )
1573 HEAP *heapPtr = HEAP_GetPtr( heap );
1574 SUBHEAP *subheap, *next;
1575 ARENA_LARGE *arena, *arena_next;
1579 TRACE("%p\n", heap );
1580 if (!heapPtr) return heap;
1582 if (heap == processHeap) return heap; /* cannot delete the main process heap */
1584 /* remove it from the per-process list */
1585 RtlEnterCriticalSection( &processHeap->critSection );
1586 list_remove( &heapPtr->entry );
1587 RtlLeaveCriticalSection( &processHeap->critSection );
1589 heapPtr->critSection.DebugInfo->Spare[0] = 0;
1590 RtlDeleteCriticalSection( &heapPtr->critSection );
1592 LIST_FOR_EACH_ENTRY_SAFE( arena, arena_next, &heapPtr->large_list, ARENA_LARGE, entry )
1594 list_remove( &arena->entry );
1597 NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1599 LIST_FOR_EACH_ENTRY_SAFE( subheap, next, &heapPtr->subheap_list, SUBHEAP, entry )
1601 if (subheap == &heapPtr->subheap) continue; /* do this one last */
1602 subheap_notify_free_all(subheap);
1603 list_remove( &subheap->entry );
1605 addr = subheap->base;
1606 NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1608 subheap_notify_free_all(&heapPtr->subheap);
1609 if (heapPtr->pending_free)
1612 addr = heapPtr->pending_free;
1613 NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1616 addr = heapPtr->subheap.base;
1617 NtFreeVirtualMemory( NtCurrentProcess(), &addr, &size, MEM_RELEASE );
1622 /***********************************************************************
1623 * RtlAllocateHeap (NTDLL.@)
1625 * Allocate a memory block from a Heap.
1628 * heap [I] Heap to allocate block from
1629 * flags [I] HEAP_ flags from "winnt.h"
1630 * size [I] Size of the memory block to allocate
1633 * Success: A pointer to the newly allocated block
1637 * This call does not SetLastError().
1639 PVOID WINAPI RtlAllocateHeap( HANDLE heap, ULONG flags, SIZE_T size )
1642 ARENA_INUSE *pInUse;
1644 HEAP *heapPtr = HEAP_GetPtr( heap );
1645 SIZE_T rounded_size;
1647 /* Validate the parameters */
1649 if (!heapPtr) return NULL;
1650 flags &= HEAP_GENERATE_EXCEPTIONS | HEAP_NO_SERIALIZE | HEAP_ZERO_MEMORY;
1651 flags |= heapPtr->flags;
1652 rounded_size = ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE( flags );
1653 if (rounded_size < size) /* overflow */
1655 if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1658 if (rounded_size < HEAP_MIN_DATA_SIZE) rounded_size = HEAP_MIN_DATA_SIZE;
1660 if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1662 if (rounded_size >= HEAP_MIN_LARGE_BLOCK_SIZE && (flags & HEAP_GROWABLE))
1664 void *ret = allocate_large_block( heap, flags, size );
1665 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1666 if (!ret && (flags & HEAP_GENERATE_EXCEPTIONS)) RtlRaiseStatus( STATUS_NO_MEMORY );
1667 TRACE("(%p,%08x,%08lx): returning %p\n", heap, flags, size, ret );
1671 /* Locate a suitable free block */
1673 if (!(pArena = HEAP_FindFreeBlock( heapPtr, rounded_size, &subheap )))
1675 TRACE("(%p,%08x,%08lx): returning NULL\n",
1676 heap, flags, size );
1677 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1678 if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1682 /* Remove the arena from the free list */
1684 list_remove( &pArena->entry );
1686 /* Build the in-use arena */
1688 pInUse = (ARENA_INUSE *)pArena;
1690 /* in-use arena is smaller than free arena,
1691 * so we have to add the difference to the size */
1692 pInUse->size = (pInUse->size & ~ARENA_FLAG_FREE) + sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
1693 pInUse->magic = ARENA_INUSE_MAGIC;
1695 /* Shrink the block */
1697 HEAP_ShrinkBlock( subheap, pInUse, rounded_size );
1698 pInUse->unused_bytes = (pInUse->size & ARENA_SIZE_MASK) - size;
1700 notify_alloc( pInUse + 1, size, flags & HEAP_ZERO_MEMORY );
1701 initialize_block( pInUse + 1, size, pInUse->unused_bytes, flags );
1703 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1705 TRACE("(%p,%08x,%08lx): returning %p\n", heap, flags, size, pInUse + 1 );
1710 /***********************************************************************
1711 * RtlFreeHeap (NTDLL.@)
1713 * Free a memory block allocated with RtlAllocateHeap().
1716 * heap [I] Heap that block was allocated from
1717 * flags [I] HEAP_ flags from "winnt.h"
1718 * ptr [I] Block to free
1721 * Success: TRUE, if ptr is NULL or was freed successfully.
1724 BOOLEAN WINAPI RtlFreeHeap( HANDLE heap, ULONG flags, PVOID ptr )
1726 ARENA_INUSE *pInUse;
1730 /* Validate the parameters */
1732 if (!ptr) return TRUE; /* freeing a NULL ptr isn't an error in Win2k */
1734 heapPtr = HEAP_GetPtr( heap );
1737 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
1741 flags &= HEAP_NO_SERIALIZE;
1742 flags |= heapPtr->flags;
1743 if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1745 /* Inform valgrind we are trying to free memory, so it can throw up an error message */
1748 /* Some sanity checks */
1749 pInUse = (ARENA_INUSE *)ptr - 1;
1750 if (!validate_block_pointer( heapPtr, &subheap, pInUse )) goto error;
1753 free_large_block( heapPtr, flags, ptr );
1755 HEAP_MakeInUseBlockFree( subheap, pInUse );
1757 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1758 TRACE("(%p,%08x,%p): returning TRUE\n", heap, flags, ptr );
1762 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1763 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
1764 TRACE("(%p,%08x,%p): returning FALSE\n", heap, flags, ptr );
1769 /***********************************************************************
1770 * RtlReAllocateHeap (NTDLL.@)
1772 * Change the size of a memory block allocated with RtlAllocateHeap().
1775 * heap [I] Heap that block was allocated from
1776 * flags [I] HEAP_ flags from "winnt.h"
1777 * ptr [I] Block to resize
1778 * size [I] Size of the memory block to allocate
1781 * Success: A pointer to the resized block (which may be different).
1784 PVOID WINAPI RtlReAllocateHeap( HANDLE heap, ULONG flags, PVOID ptr, SIZE_T size )
1786 ARENA_INUSE *pArena;
1789 SIZE_T oldBlockSize, oldActualSize, rounded_size;
1792 if (!ptr) return NULL;
1793 if (!(heapPtr = HEAP_GetPtr( heap )))
1795 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
1799 /* Validate the parameters */
1801 flags &= HEAP_GENERATE_EXCEPTIONS | HEAP_NO_SERIALIZE | HEAP_ZERO_MEMORY |
1802 HEAP_REALLOC_IN_PLACE_ONLY;
1803 flags |= heapPtr->flags;
1804 if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
1806 rounded_size = ROUND_SIZE(size) + HEAP_TAIL_EXTRA_SIZE(flags);
1807 if (rounded_size < size) goto oom; /* overflow */
1808 if (rounded_size < HEAP_MIN_DATA_SIZE) rounded_size = HEAP_MIN_DATA_SIZE;
1810 pArena = (ARENA_INUSE *)ptr - 1;
1811 if (!validate_block_pointer( heapPtr, &subheap, pArena )) goto error;
1814 if (!(ret = realloc_large_block( heapPtr, flags, ptr, size ))) goto oom;
1818 /* Check if we need to grow the block */
1820 oldBlockSize = (pArena->size & ARENA_SIZE_MASK);
1821 oldActualSize = (pArena->size & ARENA_SIZE_MASK) - pArena->unused_bytes;
1822 if (rounded_size > oldBlockSize)
1824 char *pNext = (char *)(pArena + 1) + oldBlockSize;
1826 if (rounded_size >= HEAP_MIN_LARGE_BLOCK_SIZE && (flags & HEAP_GROWABLE))
1828 if (flags & HEAP_REALLOC_IN_PLACE_ONLY) goto oom;
1829 if (!(ret = allocate_large_block( heapPtr, flags, size ))) goto oom;
1830 memcpy( ret, pArena + 1, oldActualSize );
1831 notify_free( pArena + 1 );
1832 HEAP_MakeInUseBlockFree( subheap, pArena );
1835 if ((pNext < (char *)subheap->base + subheap->size) &&
1836 (*(DWORD *)pNext & ARENA_FLAG_FREE) &&
1837 (oldBlockSize + (*(DWORD *)pNext & ARENA_SIZE_MASK) + sizeof(ARENA_FREE) >= rounded_size))
1839 /* The next block is free and large enough */
1840 ARENA_FREE *pFree = (ARENA_FREE *)pNext;
1841 list_remove( &pFree->entry );
1842 pArena->size += (pFree->size & ARENA_SIZE_MASK) + sizeof(*pFree);
1843 if (!HEAP_Commit( subheap, pArena, rounded_size )) goto oom;
1844 notify_free( pArena + 1 );
1845 HEAP_ShrinkBlock( subheap, pArena, rounded_size );
1846 notify_alloc( pArena + 1, size, FALSE );
1847 /* FIXME: this is wrong as we may lose old VBits settings */
1848 mark_block_initialized( pArena + 1, oldActualSize );
1850 else /* Do it the hard way */
1853 ARENA_INUSE *pInUse;
1854 SUBHEAP *newsubheap;
1856 if ((flags & HEAP_REALLOC_IN_PLACE_ONLY) ||
1857 !(pNew = HEAP_FindFreeBlock( heapPtr, rounded_size, &newsubheap )))
1860 /* Build the in-use arena */
1862 list_remove( &pNew->entry );
1863 pInUse = (ARENA_INUSE *)pNew;
1864 pInUse->size = (pInUse->size & ~ARENA_FLAG_FREE)
1865 + sizeof(ARENA_FREE) - sizeof(ARENA_INUSE);
1866 pInUse->magic = ARENA_INUSE_MAGIC;
1867 HEAP_ShrinkBlock( newsubheap, pInUse, rounded_size );
1869 mark_block_initialized( pInUse + 1, oldActualSize );
1870 notify_alloc( pInUse + 1, size, FALSE );
1871 memcpy( pInUse + 1, pArena + 1, oldActualSize );
1873 /* Free the previous block */
1875 notify_free( pArena + 1 );
1876 HEAP_MakeInUseBlockFree( subheap, pArena );
1877 subheap = newsubheap;
1883 /* Shrink the block */
1884 notify_free( pArena + 1 );
1885 HEAP_ShrinkBlock( subheap, pArena, rounded_size );
1886 notify_alloc( pArena + 1, size, FALSE );
1887 /* FIXME: this is wrong as we may lose old VBits settings */
1888 mark_block_initialized( pArena + 1, size );
1891 pArena->unused_bytes = (pArena->size & ARENA_SIZE_MASK) - size;
1893 /* Clear the extra bytes if needed */
1895 if (size > oldActualSize)
1896 initialize_block( (char *)(pArena + 1) + oldActualSize, size - oldActualSize,
1897 pArena->unused_bytes, flags );
1899 mark_block_tail( (char *)(pArena + 1) + size, pArena->unused_bytes, flags );
1901 /* Return the new arena */
1905 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1906 TRACE("(%p,%08x,%p,%08lx): returning %p\n", heap, flags, ptr, size, ret );
1910 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1911 if (flags & HEAP_GENERATE_EXCEPTIONS) RtlRaiseStatus( STATUS_NO_MEMORY );
1912 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_NO_MEMORY );
1913 TRACE("(%p,%08x,%p,%08lx): returning NULL\n", heap, flags, ptr, size );
1917 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
1918 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
1919 TRACE("(%p,%08x,%p,%08lx): returning NULL\n", heap, flags, ptr, size );
1924 /***********************************************************************
1925 * RtlCompactHeap (NTDLL.@)
1927 * Compact the free space in a Heap.
1930 * heap [I] Heap that block was allocated from
1931 * flags [I] HEAP_ flags from "winnt.h"
1934 * The number of bytes compacted.
1937 * This function is a harmless stub.
1939 ULONG WINAPI RtlCompactHeap( HANDLE heap, ULONG flags )
1941 static BOOL reported;
1942 if (!reported++) FIXME( "(%p, 0x%x) stub\n", heap, flags );
1947 /***********************************************************************
1948 * RtlLockHeap (NTDLL.@)
1953 * heap [I] Heap to lock
1956 * Success: TRUE. The Heap is locked.
1957 * Failure: FALSE, if heap is invalid.
1959 BOOLEAN WINAPI RtlLockHeap( HANDLE heap )
1961 HEAP *heapPtr = HEAP_GetPtr( heap );
1962 if (!heapPtr) return FALSE;
1963 RtlEnterCriticalSection( &heapPtr->critSection );
1968 /***********************************************************************
1969 * RtlUnlockHeap (NTDLL.@)
1974 * heap [I] Heap to unlock
1977 * Success: TRUE. The Heap is unlocked.
1978 * Failure: FALSE, if heap is invalid.
1980 BOOLEAN WINAPI RtlUnlockHeap( HANDLE heap )
1982 HEAP *heapPtr = HEAP_GetPtr( heap );
1983 if (!heapPtr) return FALSE;
1984 RtlLeaveCriticalSection( &heapPtr->critSection );
1989 /***********************************************************************
1990 * RtlSizeHeap (NTDLL.@)
1992 * Get the actual size of a memory block allocated from a Heap.
1995 * heap [I] Heap that block was allocated from
1996 * flags [I] HEAP_ flags from "winnt.h"
1997 * ptr [I] Block to get the size of
2000 * Success: The size of the block.
2001 * Failure: -1, heap or ptr are invalid.
2004 * The size may be bigger than what was passed to RtlAllocateHeap().
2006 SIZE_T WINAPI RtlSizeHeap( HANDLE heap, ULONG flags, const void *ptr )
2009 const ARENA_INUSE *pArena;
2011 HEAP *heapPtr = HEAP_GetPtr( heap );
2015 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_HANDLE );
2018 flags &= HEAP_NO_SERIALIZE;
2019 flags |= heapPtr->flags;
2020 if (!(flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
2022 pArena = (const ARENA_INUSE *)ptr - 1;
2023 if (!validate_block_pointer( heapPtr, &subheap, pArena ))
2025 RtlSetLastWin32ErrorAndNtStatusFromNtStatus( STATUS_INVALID_PARAMETER );
2030 const ARENA_LARGE *large_arena = (const ARENA_LARGE *)ptr - 1;
2031 ret = large_arena->data_size;
2035 ret = (pArena->size & ARENA_SIZE_MASK) - pArena->unused_bytes;
2037 if (!(flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
2039 TRACE("(%p,%08x,%p): returning %08lx\n", heap, flags, ptr, ret );
2044 /***********************************************************************
2045 * RtlValidateHeap (NTDLL.@)
2047 * Determine if a block is a valid allocation from a heap.
2050 * heap [I] Heap that block was allocated from
2051 * flags [I] HEAP_ flags from "winnt.h"
2052 * ptr [I] Block to check
2055 * Success: TRUE. The block was allocated from heap.
2056 * Failure: FALSE, if heap is invalid or ptr was not allocated from it.
2058 BOOLEAN WINAPI RtlValidateHeap( HANDLE heap, ULONG flags, LPCVOID ptr )
2060 HEAP *heapPtr = HEAP_GetPtr( heap );
2061 if (!heapPtr) return FALSE;
2062 return HEAP_IsRealArena( heapPtr, flags, ptr, QUIET );
2066 /***********************************************************************
2067 * RtlWalkHeap (NTDLL.@)
2070 * The PROCESS_HEAP_ENTRY flag values seem different between this
2071 * function and HeapWalk(). To be checked.
2073 NTSTATUS WINAPI RtlWalkHeap( HANDLE heap, PVOID entry_ptr )
2075 LPPROCESS_HEAP_ENTRY entry = entry_ptr; /* FIXME */
2076 HEAP *heapPtr = HEAP_GetPtr(heap);
2077 SUBHEAP *sub, *currentheap = NULL;
2080 int region_index = 0;
2082 if (!heapPtr || !entry) return STATUS_INVALID_PARAMETER;
2084 if (!(heapPtr->flags & HEAP_NO_SERIALIZE)) RtlEnterCriticalSection( &heapPtr->critSection );
2086 /* FIXME: enumerate large blocks too */
2088 /* set ptr to the next arena to be examined */
2090 if (!entry->lpData) /* first call (init) ? */
2092 TRACE("begin walking of heap %p.\n", heap);
2093 currentheap = &heapPtr->subheap;
2094 ptr = (char*)currentheap->base + currentheap->headerSize;
2098 ptr = entry->lpData;
2099 LIST_FOR_EACH_ENTRY( sub, &heapPtr->subheap_list, SUBHEAP, entry )
2101 if ((ptr >= (char *)sub->base) &&
2102 (ptr < (char *)sub->base + sub->size))
2109 if (currentheap == NULL)
2111 ERR("no matching subheap found, shouldn't happen !\n");
2112 ret = STATUS_NO_MORE_ENTRIES;
2116 if (((ARENA_INUSE *)ptr - 1)->magic == ARENA_INUSE_MAGIC ||
2117 ((ARENA_INUSE *)ptr - 1)->magic == ARENA_PENDING_MAGIC)
2119 ARENA_INUSE *pArena = (ARENA_INUSE *)ptr - 1;
2120 ptr += pArena->size & ARENA_SIZE_MASK;
2122 else if (((ARENA_FREE *)ptr - 1)->magic == ARENA_FREE_MAGIC)
2124 ARENA_FREE *pArena = (ARENA_FREE *)ptr - 1;
2125 ptr += pArena->size & ARENA_SIZE_MASK;
2128 ptr += entry->cbData; /* point to next arena */
2130 if (ptr > (char *)currentheap->base + currentheap->size - 1)
2131 { /* proceed with next subheap */
2132 struct list *next = list_next( &heapPtr->subheap_list, ¤theap->entry );
2134 { /* successfully finished */
2135 TRACE("end reached.\n");
2136 ret = STATUS_NO_MORE_ENTRIES;
2139 currentheap = LIST_ENTRY( next, SUBHEAP, entry );
2140 ptr = (char *)currentheap->base + currentheap->headerSize;
2145 if (*(DWORD *)ptr & ARENA_FLAG_FREE)
2147 ARENA_FREE *pArena = (ARENA_FREE *)ptr;
2149 /*TRACE("free, magic: %04x\n", pArena->magic);*/
2151 entry->lpData = pArena + 1;
2152 entry->cbData = pArena->size & ARENA_SIZE_MASK;
2153 entry->cbOverhead = sizeof(ARENA_FREE);
2154 entry->wFlags = PROCESS_HEAP_UNCOMMITTED_RANGE;
2158 ARENA_INUSE *pArena = (ARENA_INUSE *)ptr;
2160 /*TRACE("busy, magic: %04x\n", pArena->magic);*/
2162 entry->lpData = pArena + 1;
2163 entry->cbData = pArena->size & ARENA_SIZE_MASK;
2164 entry->cbOverhead = sizeof(ARENA_INUSE);
2165 entry->wFlags = (pArena->magic == ARENA_PENDING_MAGIC) ?
2166 PROCESS_HEAP_UNCOMMITTED_RANGE : PROCESS_HEAP_ENTRY_BUSY;
2167 /* FIXME: can't handle PROCESS_HEAP_ENTRY_MOVEABLE
2168 and PROCESS_HEAP_ENTRY_DDESHARE yet */
2171 entry->iRegionIndex = region_index;
2173 /* first element of heap ? */
2174 if (ptr == (char *)currentheap->base + currentheap->headerSize)
2176 entry->wFlags |= PROCESS_HEAP_REGION;
2177 entry->u.Region.dwCommittedSize = currentheap->commitSize;
2178 entry->u.Region.dwUnCommittedSize =
2179 currentheap->size - currentheap->commitSize;
2180 entry->u.Region.lpFirstBlock = /* first valid block */
2181 (char *)currentheap->base + currentheap->headerSize;
2182 entry->u.Region.lpLastBlock = /* first invalid block */
2183 (char *)currentheap->base + currentheap->size;
2185 ret = STATUS_SUCCESS;
2186 if (TRACE_ON(heap)) HEAP_DumpEntry(entry);
2189 if (!(heapPtr->flags & HEAP_NO_SERIALIZE)) RtlLeaveCriticalSection( &heapPtr->critSection );
2194 /***********************************************************************
2195 * RtlGetProcessHeaps (NTDLL.@)
2197 * Get the Heaps belonging to the current process.
2200 * count [I] size of heaps
2201 * heaps [O] Destination array for heap HANDLE's
2204 * Success: The number of Heaps allocated by the process.
2207 ULONG WINAPI RtlGetProcessHeaps( ULONG count, HANDLE *heaps )
2209 ULONG total = 1; /* main heap */
2212 RtlEnterCriticalSection( &processHeap->critSection );
2213 LIST_FOR_EACH( ptr, &processHeap->entry ) total++;
2216 *heaps++ = processHeap;
2217 LIST_FOR_EACH( ptr, &processHeap->entry )
2218 *heaps++ = LIST_ENTRY( ptr, HEAP, entry );
2220 RtlLeaveCriticalSection( &processHeap->critSection );
2224 /***********************************************************************
2225 * RtlQueryHeapInformation (NTDLL.@)
2227 NTSTATUS WINAPI RtlQueryHeapInformation( HANDLE heap, HEAP_INFORMATION_CLASS info_class,
2228 PVOID info, SIZE_T size_in, PSIZE_T size_out)
2232 case HeapCompatibilityInformation:
2233 if (size_out) *size_out = sizeof(ULONG);
2235 if (size_in < sizeof(ULONG))
2236 return STATUS_BUFFER_TOO_SMALL;
2238 *(ULONG *)info = 0; /* standard heap */
2239 return STATUS_SUCCESS;
2242 FIXME("Unknown heap information class %u\n", info_class);
2243 return STATUS_INVALID_INFO_CLASS;