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