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