2 * PROJECT: ReactOS Kernel
3 * LICENSE: BSD - See COPYING.ARM in the top level directory
4 * FILE: ntoskrnl/mm/ARM3/expool.c
5 * PURPOSE: ARM Memory Manager Executive Pool Manager
6 * PROGRAMMERS: ReactOS Portable Systems Group
9 /* INCLUDES *******************************************************************/
15 #define MODULE_INVOLVED_IN_ARM3
16 #include "../ARM3/miarm.h"
18 #undef ExAllocatePoolWithQuota
19 #undef ExAllocatePoolWithQuotaTag
21 /* GLOBALS ********************************************************************/
23 #define POOL_BIG_TABLE_ENTRY_FREE 0x1
25 typedef struct _POOL_DPC_CONTEXT
27 PPOOL_TRACKER_TABLE PoolTrackTable
;
28 SIZE_T PoolTrackTableSize
;
29 PPOOL_TRACKER_TABLE PoolTrackTableExpansion
;
30 SIZE_T PoolTrackTableSizeExpansion
;
31 } POOL_DPC_CONTEXT
, *PPOOL_DPC_CONTEXT
;
33 ULONG ExpNumberOfPagedPools
;
34 POOL_DESCRIPTOR NonPagedPoolDescriptor
;
35 PPOOL_DESCRIPTOR ExpPagedPoolDescriptor
[16 + 1];
36 PPOOL_DESCRIPTOR PoolVector
[2];
37 PKGUARDED_MUTEX ExpPagedPoolMutex
;
38 SIZE_T PoolTrackTableSize
, PoolTrackTableMask
;
39 SIZE_T PoolBigPageTableSize
, PoolBigPageTableHash
;
40 PPOOL_TRACKER_TABLE PoolTrackTable
;
41 PPOOL_TRACKER_BIG_PAGES PoolBigPageTable
;
42 KSPIN_LOCK ExpTaggedPoolLock
;
44 BOOLEAN ExStopBadTags
;
45 KSPIN_LOCK ExpLargePoolTableLock
;
46 ULONG ExpPoolBigEntriesInUse
;
50 /* Pool block/header/list access macros */
51 #define POOL_ENTRY(x) (PPOOL_HEADER)((ULONG_PTR)(x) - sizeof(POOL_HEADER))
52 #define POOL_FREE_BLOCK(x) (PLIST_ENTRY)((ULONG_PTR)(x) + sizeof(POOL_HEADER))
53 #define POOL_BLOCK(x, i) (PPOOL_HEADER)((ULONG_PTR)(x) + ((i) * POOL_BLOCK_SIZE))
54 #define POOL_NEXT_BLOCK(x) POOL_BLOCK((x), (x)->BlockSize)
55 #define POOL_PREV_BLOCK(x) POOL_BLOCK((x), -((x)->PreviousSize))
58 * Pool list access debug macros, similar to Arthur's pfnlist.c work.
59 * Microsoft actually implements similar checks in the Windows Server 2003 SP1
60 * pool code, but only for checked builds.
62 * As of Vista, however, an MSDN Blog entry by a Security Team Manager indicates
63 * that these checks are done even on retail builds, due to the increasing
64 * number of kernel-mode attacks which depend on dangling list pointers and other
65 * kinds of list-based attacks.
67 * For now, I will leave these checks on all the time, but later they are likely
68 * to be DBG-only, at least until there are enough kernel-mode security attacks
69 * against ReactOS to warrant the performance hit.
71 * For now, these are not made inline, so we can get good stack traces.
75 ExpDecodePoolLink(IN PLIST_ENTRY Link
)
77 return (PLIST_ENTRY
)((ULONG_PTR
)Link
& ~1);
82 ExpEncodePoolLink(IN PLIST_ENTRY Link
)
84 return (PLIST_ENTRY
)((ULONG_PTR
)Link
| 1);
89 ExpCheckPoolLinks(IN PLIST_ENTRY ListHead
)
91 if ((ExpDecodePoolLink(ExpDecodePoolLink(ListHead
->Flink
)->Blink
) != ListHead
) ||
92 (ExpDecodePoolLink(ExpDecodePoolLink(ListHead
->Blink
)->Flink
) != ListHead
))
94 KeBugCheckEx(BAD_POOL_HEADER
,
97 (ULONG_PTR
)ExpDecodePoolLink(ExpDecodePoolLink(ListHead
->Flink
)->Blink
),
98 (ULONG_PTR
)ExpDecodePoolLink(ExpDecodePoolLink(ListHead
->Blink
)->Flink
));
104 ExpInitializePoolListHead(IN PLIST_ENTRY ListHead
)
106 ListHead
->Flink
= ListHead
->Blink
= ExpEncodePoolLink(ListHead
);
111 ExpIsPoolListEmpty(IN PLIST_ENTRY ListHead
)
113 return (ExpDecodePoolLink(ListHead
->Flink
) == ListHead
);
118 ExpRemovePoolEntryList(IN PLIST_ENTRY Entry
)
120 PLIST_ENTRY Blink
, Flink
;
121 Flink
= ExpDecodePoolLink(Entry
->Flink
);
122 Blink
= ExpDecodePoolLink(Entry
->Blink
);
123 Flink
->Blink
= ExpEncodePoolLink(Blink
);
124 Blink
->Flink
= ExpEncodePoolLink(Flink
);
129 ExpRemovePoolHeadList(IN PLIST_ENTRY ListHead
)
131 PLIST_ENTRY Entry
, Flink
;
132 Entry
= ExpDecodePoolLink(ListHead
->Flink
);
133 Flink
= ExpDecodePoolLink(Entry
->Flink
);
134 ListHead
->Flink
= ExpEncodePoolLink(Flink
);
135 Flink
->Blink
= ExpEncodePoolLink(ListHead
);
141 ExpRemovePoolTailList(IN PLIST_ENTRY ListHead
)
143 PLIST_ENTRY Entry
, Blink
;
144 Entry
= ExpDecodePoolLink(ListHead
->Blink
);
145 Blink
= ExpDecodePoolLink(Entry
->Blink
);
146 ListHead
->Blink
= ExpEncodePoolLink(Blink
);
147 Blink
->Flink
= ExpEncodePoolLink(ListHead
);
153 ExpInsertPoolTailList(IN PLIST_ENTRY ListHead
,
154 IN PLIST_ENTRY Entry
)
157 ExpCheckPoolLinks(ListHead
);
158 Blink
= ExpDecodePoolLink(ListHead
->Blink
);
159 Entry
->Flink
= ExpEncodePoolLink(ListHead
);
160 Entry
->Blink
= ExpEncodePoolLink(Blink
);
161 Blink
->Flink
= ExpEncodePoolLink(Entry
);
162 ListHead
->Blink
= ExpEncodePoolLink(Entry
);
163 ExpCheckPoolLinks(ListHead
);
168 ExpInsertPoolHeadList(IN PLIST_ENTRY ListHead
,
169 IN PLIST_ENTRY Entry
)
172 ExpCheckPoolLinks(ListHead
);
173 Flink
= ExpDecodePoolLink(ListHead
->Flink
);
174 Entry
->Flink
= ExpEncodePoolLink(Flink
);
175 Entry
->Blink
= ExpEncodePoolLink(ListHead
);
176 Flink
->Blink
= ExpEncodePoolLink(Entry
);
177 ListHead
->Flink
= ExpEncodePoolLink(Entry
);
178 ExpCheckPoolLinks(ListHead
);
183 ExpCheckPoolHeader(IN PPOOL_HEADER Entry
)
185 PPOOL_HEADER PreviousEntry
, NextEntry
;
187 /* Is there a block before this one? */
188 if (Entry
->PreviousSize
)
191 PreviousEntry
= POOL_PREV_BLOCK(Entry
);
193 /* The two blocks must be on the same page! */
194 if (PAGE_ALIGN(Entry
) != PAGE_ALIGN(PreviousEntry
))
196 /* Something is awry */
197 KeBugCheckEx(BAD_POOL_HEADER
,
199 (ULONG_PTR
)PreviousEntry
,
204 /* This block should also indicate that it's as large as we think it is */
205 if (PreviousEntry
->BlockSize
!= Entry
->PreviousSize
)
207 /* Otherwise, someone corrupted one of the sizes */
208 DPRINT1("PreviousEntry BlockSize %lu, tag %.4s. Entry PreviousSize %lu, tag %.4s\n",
209 PreviousEntry
->BlockSize
, (char *)&PreviousEntry
->PoolTag
,
210 Entry
->PreviousSize
, (char *)&Entry
->PoolTag
);
211 KeBugCheckEx(BAD_POOL_HEADER
,
213 (ULONG_PTR
)PreviousEntry
,
218 else if (PAGE_ALIGN(Entry
) != Entry
)
220 /* If there's no block before us, we are the first block, so we should be on a page boundary */
221 KeBugCheckEx(BAD_POOL_HEADER
,
228 /* This block must have a size */
229 if (!Entry
->BlockSize
)
231 /* Someone must've corrupted this field */
232 if (Entry
->PreviousSize
)
234 PreviousEntry
= POOL_PREV_BLOCK(Entry
);
235 DPRINT1("PreviousEntry tag %.4s. Entry tag %.4s\n",
236 (char *)&PreviousEntry
->PoolTag
,
237 (char *)&Entry
->PoolTag
);
241 DPRINT1("Entry tag %.4s\n",
242 (char *)&Entry
->PoolTag
);
244 KeBugCheckEx(BAD_POOL_HEADER
,
251 /* Okay, now get the next block */
252 NextEntry
= POOL_NEXT_BLOCK(Entry
);
254 /* If this is the last block, then we'll be page-aligned, otherwise, check this block */
255 if (PAGE_ALIGN(NextEntry
) != NextEntry
)
257 /* The two blocks must be on the same page! */
258 if (PAGE_ALIGN(Entry
) != PAGE_ALIGN(NextEntry
))
260 /* Something is messed up */
261 KeBugCheckEx(BAD_POOL_HEADER
,
263 (ULONG_PTR
)NextEntry
,
268 /* And this block should think we are as large as we truly are */
269 if (NextEntry
->PreviousSize
!= Entry
->BlockSize
)
271 /* Otherwise, someone corrupted the field */
272 DPRINT1("Entry BlockSize %lu, tag %.4s. NextEntry PreviousSize %lu, tag %.4s\n",
273 Entry
->BlockSize
, (char *)&Entry
->PoolTag
,
274 NextEntry
->PreviousSize
, (char *)&NextEntry
->PoolTag
);
275 KeBugCheckEx(BAD_POOL_HEADER
,
277 (ULONG_PTR
)NextEntry
,
286 ExpCheckPoolAllocation(
294 POOL_TYPE RealPoolType
;
296 /* Get the pool header */
297 Entry
= ((PPOOL_HEADER
)P
) - 1;
299 /* Check if this is a large allocation */
300 if (PAGE_ALIGN(P
) == P
)
302 /* Lock the pool table */
303 KeAcquireSpinLock(&ExpLargePoolTableLock
, &OldIrql
);
305 /* Find the pool tag */
306 for (i
= 0; i
< PoolBigPageTableSize
; i
++)
308 /* Check if this is our allocation */
309 if (PoolBigPageTable
[i
].Va
== P
)
311 /* Make sure the tag is ok */
312 if (PoolBigPageTable
[i
].Key
!= Tag
)
314 KeBugCheckEx(BAD_POOL_CALLER
, 0x0A, (ULONG_PTR
)P
, PoolBigPageTable
[i
].Key
, Tag
);
321 /* Release the lock */
322 KeReleaseSpinLock(&ExpLargePoolTableLock
, OldIrql
);
324 if (i
== PoolBigPageTableSize
)
326 /* Did not find the allocation */
330 /* Get Pool type by address */
331 RealPoolType
= MmDeterminePoolType(P
);
336 if (Entry
->PoolTag
!= Tag
)
338 DPRINT1("Allocation has wrong pool tag! Expected '%.4s', got '%.4s' (0x%08lx)\n",
339 &Tag
, &Entry
->PoolTag
, Entry
->PoolTag
);
340 KeBugCheckEx(BAD_POOL_CALLER
, 0x0A, (ULONG_PTR
)P
, Entry
->PoolTag
, Tag
);
343 /* Check the rest of the header */
344 ExpCheckPoolHeader(Entry
);
346 /* Get Pool type from entry */
347 RealPoolType
= (Entry
->PoolType
- 1);
350 /* Should we check the pool type? */
353 /* Verify the pool type */
354 if (RealPoolType
!= PoolType
)
356 DPRINT1("Wrong pool type! Expected %s, got %s\n",
357 PoolType
& BASE_POOL_TYPE_MASK
? "PagedPool" : "NonPagedPool",
358 (Entry
->PoolType
- 1) & BASE_POOL_TYPE_MASK
? "PagedPool" : "NonPagedPool");
359 KeBugCheckEx(BAD_POOL_CALLER
, 0xCC, (ULONG_PTR
)P
, Entry
->PoolTag
, Tag
);
366 ExpCheckPoolBlocks(IN PVOID Block
)
368 BOOLEAN FoundBlock
= FALSE
;
372 /* Get the first entry for this page, make sure it really is the first */
373 Entry
= PAGE_ALIGN(Block
);
374 ASSERT(Entry
->PreviousSize
== 0);
376 /* Now scan each entry */
379 /* When we actually found our block, remember this */
380 if (Entry
== Block
) FoundBlock
= TRUE
;
382 /* Now validate this block header */
383 ExpCheckPoolHeader(Entry
);
385 /* And go to the next one, keeping track of our size */
386 Size
+= Entry
->BlockSize
;
387 Entry
= POOL_NEXT_BLOCK(Entry
);
389 /* If we hit the last block, stop */
390 if (Size
>= (PAGE_SIZE
/ POOL_BLOCK_SIZE
)) break;
392 /* If we hit the end of the page, stop */
393 if (PAGE_ALIGN(Entry
) == Entry
) break;
396 /* We must've found our block, and we must have hit the end of the page */
397 if ((PAGE_ALIGN(Entry
) != Entry
) || !(FoundBlock
))
399 /* Otherwise, the blocks are messed up */
400 KeBugCheckEx(BAD_POOL_HEADER
, 10, (ULONG_PTR
)Block
, __LINE__
, (ULONG_PTR
)Entry
);
406 ExpCheckPoolIrqlLevel(IN POOL_TYPE PoolType
,
407 IN SIZE_T NumberOfBytes
,
411 // Validate IRQL: It must be APC_LEVEL or lower for Paged Pool, and it must
412 // be DISPATCH_LEVEL or lower for Non Paged Pool
414 if (((PoolType
& BASE_POOL_TYPE_MASK
) == PagedPool
) ?
415 (KeGetCurrentIrql() > APC_LEVEL
) :
416 (KeGetCurrentIrql() > DISPATCH_LEVEL
))
419 // Take the system down
421 KeBugCheckEx(BAD_POOL_CALLER
,
422 !Entry
? POOL_ALLOC_IRQL_INVALID
: POOL_FREE_IRQL_INVALID
,
425 !Entry
? NumberOfBytes
: (ULONG_PTR
)Entry
);
431 ExpComputeHashForTag(IN ULONG Tag
,
432 IN SIZE_T BucketMask
)
435 // Compute the hash by multiplying with a large prime number and then XORing
436 // with the HIDWORD of the result.
438 // Finally, AND with the bucket mask to generate a valid index/bucket into
441 ULONGLONG Result
= (ULONGLONG
)40543 * Tag
;
442 return (ULONG
)BucketMask
& ((ULONG
)Result
^ (Result
>> 32));
447 ExpComputePartialHashForAddress(IN PVOID BaseAddress
)
451 // Compute the hash by converting the address into a page number, and then
452 // XORing each nibble with the next one.
454 // We do *NOT* AND with the bucket mask at this point because big table expansion
455 // might happen. Therefore, the final step of the hash must be performed
456 // while holding the expansion pushlock, and this is why we call this a
457 // "partial" hash only.
459 Result
= (ULONG
)((ULONG_PTR
)BaseAddress
>> PAGE_SHIFT
);
460 return (Result
>> 24) ^ (Result
>> 16) ^ (Result
>> 8) ^ Result
;
463 /* PRIVATE FUNCTIONS **********************************************************/
470 ULONG i
, Key
, Hash
, Index
;
471 PPOOL_TRACKER_TABLE TrackTable
= PoolTrackTable
;
541 // Loop all 64 hot tags
543 ASSERT((sizeof(TagList
) / sizeof(ULONG
)) == 64);
544 for (i
= 0; i
< sizeof(TagList
) / sizeof(ULONG
); i
++)
547 // Get the current tag, and compute its hash in the tracker table
550 Hash
= ExpComputeHashForTag(Key
, PoolTrackTableMask
);
553 // Loop all the hashes in this index/bucket
559 // Find an empty entry, and make sure this isn't the last hash that
562 // On checked builds, also make sure this is the first time we are
565 ASSERT(TrackTable
[Hash
].Key
!= Key
);
566 if (!(TrackTable
[Hash
].Key
) && (Hash
!= PoolTrackTableSize
- 1))
569 // It has been seeded, move on to the next tag
571 TrackTable
[Hash
].Key
= Key
;
576 // This entry was already taken, compute the next possible hash while
577 // making sure we're not back at our initial index.
579 ASSERT(TrackTable
[Hash
].Key
!= Key
);
580 Hash
= (Hash
+ 1) & PoolTrackTableMask
;
581 if (Hash
== Index
) break;
588 ExpRemovePoolTracker(IN ULONG Key
,
589 IN SIZE_T NumberOfBytes
,
590 IN POOL_TYPE PoolType
)
593 PPOOL_TRACKER_TABLE Table
, TableEntry
;
594 SIZE_T TableMask
, TableSize
;
597 // Remove the PROTECTED_POOL flag which is not part of the tag
599 Key
&= ~PROTECTED_POOL
;
602 // With WinDBG you can set a tag you want to break on when an allocation is
605 if (Key
== PoolHitTag
) DbgBreakPoint();
608 // Why the double indirection? Because normally this function is also used
609 // when doing session pool allocations, which has another set of tables,
610 // sizes, and masks that live in session pool. Now we don't support session
611 // pool so we only ever use the regular tables, but I'm keeping the code this
612 // way so that the day we DO support session pool, it won't require that
615 Table
= PoolTrackTable
;
616 TableMask
= PoolTrackTableMask
;
617 TableSize
= PoolTrackTableSize
;
618 DBG_UNREFERENCED_LOCAL_VARIABLE(TableSize
);
621 // Compute the hash for this key, and loop all the possible buckets
623 Hash
= ExpComputeHashForTag(Key
, TableMask
);
628 // Have we found the entry for this tag? */
630 TableEntry
= &Table
[Hash
];
631 if (TableEntry
->Key
== Key
)
634 // Decrement the counters depending on if this was paged or nonpaged
637 if ((PoolType
& BASE_POOL_TYPE_MASK
) == NonPagedPool
)
639 InterlockedIncrement(&TableEntry
->NonPagedFrees
);
640 InterlockedExchangeAddSizeT(&TableEntry
->NonPagedBytes
,
641 -(SSIZE_T
)NumberOfBytes
);
644 InterlockedIncrement(&TableEntry
->PagedFrees
);
645 InterlockedExchangeAddSizeT(&TableEntry
->PagedBytes
,
646 -(SSIZE_T
)NumberOfBytes
);
651 // We should have only ended up with an empty entry if we've reached
654 if (!TableEntry
->Key
)
656 DPRINT1("Empty item reached in tracker table. Hash=0x%lx, TableMask=0x%lx, Tag=0x%08lx, NumberOfBytes=%lu, PoolType=%d\n",
657 Hash
, TableMask
, Key
, (ULONG
)NumberOfBytes
, PoolType
);
658 ASSERT(Hash
== TableMask
);
662 // This path is hit when we don't have an entry, and the current bucket
663 // is full, so we simply try the next one
665 Hash
= (Hash
+ 1) & TableMask
;
666 if (Hash
== Index
) break;
670 // And finally this path is hit when all the buckets are full, and we need
671 // some expansion. This path is not yet supported in ReactOS and so we'll
674 DPRINT1("Out of pool tag space, ignoring...\n");
679 ExpInsertPoolTracker(IN ULONG Key
,
680 IN SIZE_T NumberOfBytes
,
681 IN POOL_TYPE PoolType
)
685 PPOOL_TRACKER_TABLE Table
, TableEntry
;
686 SIZE_T TableMask
, TableSize
;
689 // Remove the PROTECTED_POOL flag which is not part of the tag
691 Key
&= ~PROTECTED_POOL
;
694 // With WinDBG you can set a tag you want to break on when an allocation is
697 if (Key
== PoolHitTag
) DbgBreakPoint();
700 // There is also an internal flag you can set to break on malformed tags
702 if (ExStopBadTags
) ASSERT(Key
& 0xFFFFFF00);
705 // ASSERT on ReactOS features not yet supported
707 ASSERT(!(PoolType
& SESSION_POOL_MASK
));
708 ASSERT(KeGetCurrentProcessorNumber() == 0);
711 // Why the double indirection? Because normally this function is also used
712 // when doing session pool allocations, which has another set of tables,
713 // sizes, and masks that live in session pool. Now we don't support session
714 // pool so we only ever use the regular tables, but I'm keeping the code this
715 // way so that the day we DO support session pool, it won't require that
718 Table
= PoolTrackTable
;
719 TableMask
= PoolTrackTableMask
;
720 TableSize
= PoolTrackTableSize
;
721 DBG_UNREFERENCED_LOCAL_VARIABLE(TableSize
);
724 // Compute the hash for this key, and loop all the possible buckets
726 Hash
= ExpComputeHashForTag(Key
, TableMask
);
731 // Do we already have an entry for this tag? */
733 TableEntry
= &Table
[Hash
];
734 if (TableEntry
->Key
== Key
)
737 // Increment the counters depending on if this was paged or nonpaged
740 if ((PoolType
& BASE_POOL_TYPE_MASK
) == NonPagedPool
)
742 InterlockedIncrement(&TableEntry
->NonPagedAllocs
);
743 InterlockedExchangeAddSizeT(&TableEntry
->NonPagedBytes
, NumberOfBytes
);
746 InterlockedIncrement(&TableEntry
->PagedAllocs
);
747 InterlockedExchangeAddSizeT(&TableEntry
->PagedBytes
, NumberOfBytes
);
752 // We don't have an entry yet, but we've found a free bucket for it
754 if (!(TableEntry
->Key
) && (Hash
!= PoolTrackTableSize
- 1))
757 // We need to hold the lock while creating a new entry, since other
758 // processors might be in this code path as well
760 ExAcquireSpinLock(&ExpTaggedPoolLock
, &OldIrql
);
761 if (!PoolTrackTable
[Hash
].Key
)
764 // We've won the race, so now create this entry in the bucket
766 ASSERT(Table
[Hash
].Key
== 0);
767 PoolTrackTable
[Hash
].Key
= Key
;
768 TableEntry
->Key
= Key
;
770 ExReleaseSpinLock(&ExpTaggedPoolLock
, OldIrql
);
773 // Now we force the loop to run again, and we should now end up in
774 // the code path above which does the interlocked increments...
780 // This path is hit when we don't have an entry, and the current bucket
781 // is full, so we simply try the next one
783 Hash
= (Hash
+ 1) & TableMask
;
784 if (Hash
== Index
) break;
788 // And finally this path is hit when all the buckets are full, and we need
789 // some expansion. This path is not yet supported in ReactOS and so we'll
792 DPRINT1("Out of pool tag space, ignoring...\n");
798 ExInitializePoolDescriptor(IN PPOOL_DESCRIPTOR PoolDescriptor
,
799 IN POOL_TYPE PoolType
,
804 PLIST_ENTRY NextEntry
, LastEntry
;
807 // Setup the descriptor based on the caller's request
809 PoolDescriptor
->PoolType
= PoolType
;
810 PoolDescriptor
->PoolIndex
= PoolIndex
;
811 PoolDescriptor
->Threshold
= Threshold
;
812 PoolDescriptor
->LockAddress
= PoolLock
;
815 // Initialize accounting data
817 PoolDescriptor
->RunningAllocs
= 0;
818 PoolDescriptor
->RunningDeAllocs
= 0;
819 PoolDescriptor
->TotalPages
= 0;
820 PoolDescriptor
->TotalBytes
= 0;
821 PoolDescriptor
->TotalBigPages
= 0;
824 // Nothing pending for now
826 PoolDescriptor
->PendingFrees
= NULL
;
827 PoolDescriptor
->PendingFreeDepth
= 0;
830 // Loop all the descriptor's allocation lists and initialize them
832 NextEntry
= PoolDescriptor
->ListHeads
;
833 LastEntry
= NextEntry
+ POOL_LISTS_PER_PAGE
;
834 while (NextEntry
< LastEntry
)
836 ExpInitializePoolListHead(NextEntry
);
841 // Note that ReactOS does not support Session Pool Yet
843 ASSERT(PoolType
!= PagedPoolSession
);
849 InitializePool(IN POOL_TYPE PoolType
,
852 PPOOL_DESCRIPTOR Descriptor
;
857 // Check what kind of pool this is
859 if (PoolType
== NonPagedPool
)
862 // Compute the track table size and convert it from a power of two to an
865 // NOTE: On checked builds, we'll assert if the registry table size was
866 // invalid, while on retail builds we'll just break out of the loop at
869 TableSize
= min(PoolTrackTableSize
, MmSizeOfNonPagedPoolInBytes
>> 8);
870 for (i
= 0; i
< 32; i
++)
874 ASSERT((TableSize
& ~1) == 0);
875 if (!(TableSize
& ~1)) break;
881 // If we hit bit 32, than no size was defined in the registry, so
882 // we'll use the default size of 2048 entries.
884 // Otherwise, use the size from the registry, as long as it's not
885 // smaller than 64 entries.
889 PoolTrackTableSize
= 2048;
893 PoolTrackTableSize
= max(1 << i
, 64);
897 // Loop trying with the biggest specified size first, and cut it down
898 // by a power of two each iteration in case not enough memory exist
903 // Do not allow overflow
905 if ((PoolTrackTableSize
+ 1) > (MAXULONG_PTR
/ sizeof(POOL_TRACKER_TABLE
)))
907 PoolTrackTableSize
>>= 1;
912 // Allocate the tracker table and exit the loop if this worked
914 PoolTrackTable
= MiAllocatePoolPages(NonPagedPool
,
915 (PoolTrackTableSize
+ 1) *
916 sizeof(POOL_TRACKER_TABLE
));
917 if (PoolTrackTable
) break;
920 // Otherwise, as long as we're not down to the last bit, keep
923 if (PoolTrackTableSize
== 1)
925 KeBugCheckEx(MUST_SUCCEED_POOL_EMPTY
,
931 PoolTrackTableSize
>>= 1;
935 // Finally, add one entry, compute the hash, and zero the table
937 PoolTrackTableSize
++;
938 PoolTrackTableMask
= PoolTrackTableSize
- 2;
940 RtlZeroMemory(PoolTrackTable
,
941 PoolTrackTableSize
* sizeof(POOL_TRACKER_TABLE
));
944 // We now do the exact same thing with the tracker table for big pages
946 TableSize
= min(PoolBigPageTableSize
, MmSizeOfNonPagedPoolInBytes
>> 8);
947 for (i
= 0; i
< 32; i
++)
951 ASSERT((TableSize
& ~1) == 0);
952 if (!(TableSize
& ~1)) break;
958 // For big pages, the default tracker table is 4096 entries, while the
959 // minimum is still 64
963 PoolBigPageTableSize
= 4096;
967 PoolBigPageTableSize
= max(1 << i
, 64);
971 // Again, run the exact same loop we ran earlier, but this time for the
972 // big pool tracker instead
976 if ((PoolBigPageTableSize
+ 1) > (MAXULONG_PTR
/ sizeof(POOL_TRACKER_BIG_PAGES
)))
978 PoolBigPageTableSize
>>= 1;
982 PoolBigPageTable
= MiAllocatePoolPages(NonPagedPool
,
983 PoolBigPageTableSize
*
984 sizeof(POOL_TRACKER_BIG_PAGES
));
985 if (PoolBigPageTable
) break;
987 if (PoolBigPageTableSize
== 1)
989 KeBugCheckEx(MUST_SUCCEED_POOL_EMPTY
,
996 PoolBigPageTableSize
>>= 1;
1000 // An extra entry is not needed for for the big pool tracker, so just
1001 // compute the hash and zero it
1003 PoolBigPageTableHash
= PoolBigPageTableSize
- 1;
1004 RtlZeroMemory(PoolBigPageTable
,
1005 PoolBigPageTableSize
* sizeof(POOL_TRACKER_BIG_PAGES
));
1006 for (i
= 0; i
< PoolBigPageTableSize
; i
++) PoolBigPageTable
[i
].Va
= (PVOID
)1;
1009 // During development, print this out so we can see what's happening
1011 DPRINT("EXPOOL: Pool Tracker Table at: 0x%p with 0x%lx bytes\n",
1012 PoolTrackTable
, PoolTrackTableSize
* sizeof(POOL_TRACKER_TABLE
));
1013 DPRINT("EXPOOL: Big Pool Tracker Table at: 0x%p with 0x%lx bytes\n",
1014 PoolBigPageTable
, PoolBigPageTableSize
* sizeof(POOL_TRACKER_BIG_PAGES
));
1017 // Insert the generic tracker for all of big pool
1019 ExpInsertPoolTracker('looP',
1020 ROUND_TO_PAGES(PoolBigPageTableSize
*
1021 sizeof(POOL_TRACKER_BIG_PAGES
)),
1025 // No support for NUMA systems at this time
1027 ASSERT(KeNumberNodes
== 1);
1030 // Initialize the tag spinlock
1032 KeInitializeSpinLock(&ExpTaggedPoolLock
);
1035 // Initialize the nonpaged pool descriptor
1037 PoolVector
[NonPagedPool
] = &NonPagedPoolDescriptor
;
1038 ExInitializePoolDescriptor(PoolVector
[NonPagedPool
],
1047 // No support for NUMA systems at this time
1049 ASSERT(KeNumberNodes
== 1);
1052 // Allocate the pool descriptor
1054 Descriptor
= ExAllocatePoolWithTag(NonPagedPool
,
1055 sizeof(KGUARDED_MUTEX
) +
1056 sizeof(POOL_DESCRIPTOR
),
1061 // This is really bad...
1063 KeBugCheckEx(MUST_SUCCEED_POOL_EMPTY
,
1071 // Setup the vector and guarded mutex for paged pool
1073 PoolVector
[PagedPool
] = Descriptor
;
1074 ExpPagedPoolMutex
= (PKGUARDED_MUTEX
)(Descriptor
+ 1);
1075 ExpPagedPoolDescriptor
[0] = Descriptor
;
1076 KeInitializeGuardedMutex(ExpPagedPoolMutex
);
1077 ExInitializePoolDescriptor(Descriptor
,
1084 // Insert the generic tracker for all of nonpaged pool
1086 ExpInsertPoolTracker('looP',
1087 ROUND_TO_PAGES(PoolTrackTableSize
* sizeof(POOL_TRACKER_TABLE
)),
1094 ExLockPool(IN PPOOL_DESCRIPTOR Descriptor
)
1097 // Check if this is nonpaged pool
1099 if ((Descriptor
->PoolType
& BASE_POOL_TYPE_MASK
) == NonPagedPool
)
1102 // Use the queued spin lock
1104 return KeAcquireQueuedSpinLock(LockQueueNonPagedPoolLock
);
1109 // Use the guarded mutex
1111 KeAcquireGuardedMutex(Descriptor
->LockAddress
);
1118 ExUnlockPool(IN PPOOL_DESCRIPTOR Descriptor
,
1122 // Check if this is nonpaged pool
1124 if ((Descriptor
->PoolType
& BASE_POOL_TYPE_MASK
) == NonPagedPool
)
1127 // Use the queued spin lock
1129 KeReleaseQueuedSpinLock(LockQueueNonPagedPoolLock
, OldIrql
);
1134 // Use the guarded mutex
1136 KeReleaseGuardedMutex(Descriptor
->LockAddress
);
1142 ExpGetPoolTagInfoTarget(IN PKDPC Dpc
,
1143 IN PVOID DeferredContext
,
1144 IN PVOID SystemArgument1
,
1145 IN PVOID SystemArgument2
)
1147 PPOOL_DPC_CONTEXT Context
= DeferredContext
;
1148 UNREFERENCED_PARAMETER(Dpc
);
1149 ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL
);
1152 // Make sure we win the race, and if we did, copy the data atomically
1154 if (KeSignalCallDpcSynchronize(SystemArgument2
))
1156 RtlCopyMemory(Context
->PoolTrackTable
,
1158 Context
->PoolTrackTableSize
* sizeof(POOL_TRACKER_TABLE
));
1161 // This is here because ReactOS does not yet support expansion
1163 ASSERT(Context
->PoolTrackTableSizeExpansion
== 0);
1167 // Regardless of whether we won or not, we must now synchronize and then
1168 // decrement the barrier since this is one more processor that has completed
1171 KeSignalCallDpcSynchronize(SystemArgument2
);
1172 KeSignalCallDpcDone(SystemArgument1
);
1177 ExGetPoolTagInfo(IN PSYSTEM_POOLTAG_INFORMATION SystemInformation
,
1178 IN ULONG SystemInformationLength
,
1179 IN OUT PULONG ReturnLength OPTIONAL
)
1181 ULONG TableSize
, CurrentLength
;
1183 NTSTATUS Status
= STATUS_SUCCESS
;
1184 PSYSTEM_POOLTAG TagEntry
;
1185 PPOOL_TRACKER_TABLE Buffer
, TrackerEntry
;
1186 POOL_DPC_CONTEXT Context
;
1187 ASSERT(KeGetCurrentIrql() == PASSIVE_LEVEL
);
1190 // Keep track of how much data the caller's buffer must hold
1192 CurrentLength
= FIELD_OFFSET(SYSTEM_POOLTAG_INFORMATION
, TagInfo
);
1195 // Initialize the caller's buffer
1197 TagEntry
= &SystemInformation
->TagInfo
[0];
1198 SystemInformation
->Count
= 0;
1201 // Capture the number of entries, and the total size needed to make a copy
1204 EntryCount
= (ULONG
)PoolTrackTableSize
;
1205 TableSize
= EntryCount
* sizeof(POOL_TRACKER_TABLE
);
1208 // Allocate the "Generic DPC" temporary buffer
1210 Buffer
= ExAllocatePoolWithTag(NonPagedPool
, TableSize
, 'ofnI');
1211 if (!Buffer
) return STATUS_INSUFFICIENT_RESOURCES
;
1214 // Do a "Generic DPC" to atomically retrieve the tag and allocation data
1216 Context
.PoolTrackTable
= Buffer
;
1217 Context
.PoolTrackTableSize
= PoolTrackTableSize
;
1218 Context
.PoolTrackTableExpansion
= NULL
;
1219 Context
.PoolTrackTableSizeExpansion
= 0;
1220 KeGenericCallDpc(ExpGetPoolTagInfoTarget
, &Context
);
1223 // Now parse the results
1225 for (TrackerEntry
= Buffer
; TrackerEntry
< (Buffer
+ EntryCount
); TrackerEntry
++)
1228 // If the entry is empty, skip it
1230 if (!TrackerEntry
->Key
) continue;
1233 // Otherwise, add one more entry to the caller's buffer, and ensure that
1234 // enough space has been allocated in it
1236 SystemInformation
->Count
++;
1237 CurrentLength
+= sizeof(*TagEntry
);
1238 if (SystemInformationLength
< CurrentLength
)
1241 // The caller's buffer is too small, so set a failure code. The
1242 // caller will know the count, as well as how much space is needed.
1244 // We do NOT break out of the loop, because we want to keep incrementing
1245 // the Count as well as CurrentLength so that the caller can know the
1248 Status
= STATUS_INFO_LENGTH_MISMATCH
;
1253 // Small sanity check that our accounting is working correctly
1255 ASSERT(TrackerEntry
->PagedAllocs
>= TrackerEntry
->PagedFrees
);
1256 ASSERT(TrackerEntry
->NonPagedAllocs
>= TrackerEntry
->NonPagedFrees
);
1259 // Return the data into the caller's buffer
1261 TagEntry
->TagUlong
= TrackerEntry
->Key
;
1262 TagEntry
->PagedAllocs
= TrackerEntry
->PagedAllocs
;
1263 TagEntry
->PagedFrees
= TrackerEntry
->PagedFrees
;
1264 TagEntry
->PagedUsed
= TrackerEntry
->PagedBytes
;
1265 TagEntry
->NonPagedAllocs
= TrackerEntry
->NonPagedAllocs
;
1266 TagEntry
->NonPagedFrees
= TrackerEntry
->NonPagedFrees
;
1267 TagEntry
->NonPagedUsed
= TrackerEntry
->NonPagedBytes
;
1273 // Free the "Generic DPC" temporary buffer, return the buffer length and status
1275 ExFreePoolWithTag(Buffer
, 'ofnI');
1276 if (ReturnLength
) *ReturnLength
= CurrentLength
;
1282 ExpAddTagForBigPages(IN PVOID Va
,
1284 IN ULONG NumberOfPages
,
1285 IN POOL_TYPE PoolType
)
1291 PPOOL_TRACKER_BIG_PAGES Entry
, EntryEnd
, EntryStart
;
1292 ASSERT(((ULONG_PTR
)Va
& POOL_BIG_TABLE_ENTRY_FREE
) == 0);
1293 ASSERT(!(PoolType
& SESSION_POOL_MASK
));
1296 // As the table is expandable, these values must only be read after acquiring
1297 // the lock to avoid a teared access during an expansion
1299 Hash
= ExpComputePartialHashForAddress(Va
);
1300 KeAcquireSpinLock(&ExpLargePoolTableLock
, &OldIrql
);
1301 Hash
&= PoolBigPageTableHash
;
1302 TableSize
= PoolBigPageTableSize
;
1305 // We loop from the current hash bucket to the end of the table, and then
1306 // rollover to hash bucket 0 and keep going from there. If we return back
1307 // to the beginning, then we attempt expansion at the bottom of the loop
1309 EntryStart
= Entry
= &PoolBigPageTable
[Hash
];
1310 EntryEnd
= &PoolBigPageTable
[TableSize
];
1314 // Make sure that this is a free entry and attempt to atomically make the
1318 if (((ULONG_PTR
)OldVa
& POOL_BIG_TABLE_ENTRY_FREE
) &&
1319 (InterlockedCompareExchangePointer(&Entry
->Va
, Va
, OldVa
) == OldVa
))
1322 // We now own this entry, write down the size and the pool tag
1325 Entry
->NumberOfPages
= NumberOfPages
;
1328 // Add one more entry to the count, and see if we're getting within
1329 // 25% of the table size, at which point we'll do an expansion now
1330 // to avoid blocking too hard later on.
1332 // Note that we only do this if it's also been the 16th time that we
1333 // keep losing the race or that we are not finding a free entry anymore,
1334 // which implies a massive number of concurrent big pool allocations.
1336 InterlockedIncrementUL(&ExpPoolBigEntriesInUse
);
1337 if ((i
>= 16) && (ExpPoolBigEntriesInUse
> (TableSize
/ 4)))
1339 DPRINT("Should attempt expansion since we now have %lu entries\n",
1340 ExpPoolBigEntriesInUse
);
1344 // We have our entry, return
1346 KeReleaseSpinLock(&ExpLargePoolTableLock
, OldIrql
);
1351 // We don't have our entry yet, so keep trying, making the entry list
1352 // circular if we reach the last entry. We'll eventually break out of
1353 // the loop once we've rolled over and returned back to our original
1357 if (++Entry
>= EntryEnd
) Entry
= &PoolBigPageTable
[0];
1358 } while (Entry
!= EntryStart
);
1361 // This means there's no free hash buckets whatsoever, so we would now have
1362 // to attempt expanding the table
1364 DPRINT1("Big pool expansion needed, not implemented!\n");
1365 KeReleaseSpinLock(&ExpLargePoolTableLock
, OldIrql
);
1371 ExpFindAndRemoveTagBigPages(IN PVOID Va
,
1372 OUT PULONG_PTR BigPages
,
1373 IN POOL_TYPE PoolType
)
1375 BOOLEAN FirstTry
= TRUE
;
1378 ULONG PoolTag
, Hash
;
1379 PPOOL_TRACKER_BIG_PAGES Entry
;
1380 ASSERT(((ULONG_PTR
)Va
& POOL_BIG_TABLE_ENTRY_FREE
) == 0);
1381 ASSERT(!(PoolType
& SESSION_POOL_MASK
));
1384 // As the table is expandable, these values must only be read after acquiring
1385 // the lock to avoid a teared access during an expansion
1387 Hash
= ExpComputePartialHashForAddress(Va
);
1388 KeAcquireSpinLock(&ExpLargePoolTableLock
, &OldIrql
);
1389 Hash
&= PoolBigPageTableHash
;
1390 TableSize
= PoolBigPageTableSize
;
1393 // Loop while trying to find this big page allocation
1395 while (PoolBigPageTable
[Hash
].Va
!= Va
)
1398 // Increment the size until we go past the end of the table
1400 if (++Hash
>= TableSize
)
1403 // Is this the second time we've tried?
1408 // This means it was never inserted into the pool table and it
1409 // received the special "BIG" tag -- return that and return 0
1410 // so that the code can ask Mm for the page count instead
1412 KeReleaseSpinLock(&ExpLargePoolTableLock
, OldIrql
);
1418 // The first time this happens, reset the hash index and try again
1426 // Now capture all the information we need from the entry, since after we
1427 // release the lock, the data can change
1429 Entry
= &PoolBigPageTable
[Hash
];
1430 *BigPages
= Entry
->NumberOfPages
;
1431 PoolTag
= Entry
->Key
;
1434 // Set the free bit, and decrement the number of allocations. Finally, release
1435 // the lock and return the tag that was located
1437 InterlockedIncrement((PLONG
)&Entry
->Va
);
1438 InterlockedDecrementUL(&ExpPoolBigEntriesInUse
);
1439 KeReleaseSpinLock(&ExpLargePoolTableLock
, OldIrql
);
1445 ExQueryPoolUsage(OUT PULONG PagedPoolPages
,
1446 OUT PULONG NonPagedPoolPages
,
1447 OUT PULONG PagedPoolAllocs
,
1448 OUT PULONG PagedPoolFrees
,
1449 OUT PULONG PagedPoolLookasideHits
,
1450 OUT PULONG NonPagedPoolAllocs
,
1451 OUT PULONG NonPagedPoolFrees
,
1452 OUT PULONG NonPagedPoolLookasideHits
)
1455 PPOOL_DESCRIPTOR PoolDesc
;
1458 // Assume all failures
1460 *PagedPoolPages
= 0;
1461 *PagedPoolAllocs
= 0;
1462 *PagedPoolFrees
= 0;
1465 // Tally up the totals for all the apged pool
1467 for (i
= 0; i
< ExpNumberOfPagedPools
+ 1; i
++)
1469 PoolDesc
= ExpPagedPoolDescriptor
[i
];
1470 *PagedPoolPages
+= PoolDesc
->TotalPages
+ PoolDesc
->TotalBigPages
;
1471 *PagedPoolAllocs
+= PoolDesc
->RunningAllocs
;
1472 *PagedPoolFrees
+= PoolDesc
->RunningDeAllocs
;
1476 // The first non-paged pool has a hardcoded well-known descriptor name
1478 PoolDesc
= &NonPagedPoolDescriptor
;
1479 *NonPagedPoolPages
= PoolDesc
->TotalPages
+ PoolDesc
->TotalBigPages
;
1480 *NonPagedPoolAllocs
= PoolDesc
->RunningAllocs
;
1481 *NonPagedPoolFrees
= PoolDesc
->RunningDeAllocs
;
1484 // If the system has more than one non-paged pool, copy the other descriptor
1488 if (ExpNumberOfNonPagedPools
> 1)
1490 for (i
= 0; i
< ExpNumberOfNonPagedPools
; i
++)
1492 PoolDesc
= ExpNonPagedPoolDescriptor
[i
];
1493 *NonPagedPoolPages
+= PoolDesc
->TotalPages
+ PoolDesc
->TotalBigPages
;
1494 *NonPagedPoolAllocs
+= PoolDesc
->RunningAllocs
;
1495 *NonPagedPoolFrees
+= PoolDesc
->RunningDeAllocs
;
1501 // FIXME: Not yet supported
1503 *NonPagedPoolLookasideHits
+= 0;
1504 *PagedPoolLookasideHits
+= 0;
1507 /* PUBLIC FUNCTIONS ***********************************************************/
1514 ExAllocatePoolWithTag(IN POOL_TYPE PoolType
,
1515 IN SIZE_T NumberOfBytes
,
1518 PPOOL_DESCRIPTOR PoolDesc
;
1519 PLIST_ENTRY ListHead
;
1520 PPOOL_HEADER Entry
, NextEntry
, FragmentEntry
;
1522 USHORT BlockSize
, i
;
1524 PKPRCB Prcb
= KeGetCurrentPrcb();
1525 PGENERAL_LOOKASIDE LookasideList
;
1528 // Some sanity checks
1531 ASSERT(Tag
!= ' GIB');
1532 ASSERT(NumberOfBytes
!= 0);
1533 ExpCheckPoolIrqlLevel(PoolType
, NumberOfBytes
, NULL
);
1536 // Not supported in ReactOS
1538 ASSERT(!(PoolType
& SESSION_POOL_MASK
));
1541 // Check if verifier or special pool is enabled
1543 if (ExpPoolFlags
& (POOL_FLAG_VERIFIER
| POOL_FLAG_SPECIAL_POOL
))
1546 // For verifier, we should call the verification routine
1548 if (ExpPoolFlags
& POOL_FLAG_VERIFIER
)
1550 DPRINT1("Driver Verifier is not yet supported\n");
1554 // For special pool, we check if this is a suitable allocation and do
1555 // the special allocation if needed
1557 if (ExpPoolFlags
& POOL_FLAG_SPECIAL_POOL
)
1560 // Check if this is a special pool allocation
1562 if (MmUseSpecialPool(NumberOfBytes
, Tag
))
1565 // Try to allocate using special pool
1567 Entry
= MmAllocateSpecialPool(NumberOfBytes
, Tag
, PoolType
, 2);
1568 if (Entry
) return Entry
;
1574 // Get the pool type and its corresponding vector for this request
1576 OriginalType
= PoolType
;
1577 PoolType
= PoolType
& BASE_POOL_TYPE_MASK
;
1578 PoolDesc
= PoolVector
[PoolType
];
1579 ASSERT(PoolDesc
!= NULL
);
1582 // Check if this is a big page allocation
1584 if (NumberOfBytes
> POOL_MAX_ALLOC
)
1587 // Allocate pages for it
1589 Entry
= MiAllocatePoolPages(OriginalType
, NumberOfBytes
);
1593 // Must succeed pool is deprecated, but still supported. These allocation
1594 // failures must cause an immediate bugcheck
1596 if (OriginalType
& MUST_SUCCEED_POOL_MASK
)
1598 KeBugCheckEx(MUST_SUCCEED_POOL_EMPTY
,
1600 NonPagedPoolDescriptor
.TotalPages
,
1601 NonPagedPoolDescriptor
.TotalBigPages
,
1606 // Internal debugging
1611 // This flag requests printing failures, and can also further specify
1612 // breaking on failures
1614 if (ExpPoolFlags
& POOL_FLAG_DBGPRINT_ON_FAILURE
)
1616 DPRINT1("EX: ExAllocatePool (%lu, 0x%x) returning NULL\n",
1619 if (ExpPoolFlags
& POOL_FLAG_CRASH_ON_FAILURE
) DbgBreakPoint();
1623 // Finally, this flag requests an exception, which we are more than
1626 if (OriginalType
& POOL_RAISE_IF_ALLOCATION_FAILURE
)
1628 ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES
);
1633 // Increment required counters
1635 InterlockedExchangeAdd((PLONG
)&PoolDesc
->TotalBigPages
,
1636 (LONG
)BYTES_TO_PAGES(NumberOfBytes
));
1637 InterlockedExchangeAddSizeT(&PoolDesc
->TotalBytes
, NumberOfBytes
);
1638 InterlockedIncrement((PLONG
)&PoolDesc
->RunningAllocs
);
1641 // Add a tag for the big page allocation and switch to the generic "BIG"
1642 // tag if we failed to do so, then insert a tracker for this alloation.
1644 if (!ExpAddTagForBigPages(Entry
,
1646 (ULONG
)BYTES_TO_PAGES(NumberOfBytes
),
1651 ExpInsertPoolTracker(Tag
, ROUND_TO_PAGES(NumberOfBytes
), OriginalType
);
1656 // Should never request 0 bytes from the pool, but since so many drivers do
1657 // it, we'll just assume they want 1 byte, based on NT's similar behavior
1659 if (!NumberOfBytes
) NumberOfBytes
= 1;
1662 // A pool allocation is defined by its data, a linked list to connect it to
1663 // the free list (if necessary), and a pool header to store accounting info.
1664 // Calculate this size, then convert it into a block size (units of pool
1667 // Note that i cannot overflow (past POOL_LISTS_PER_PAGE) because any such
1668 // request would've been treated as a POOL_MAX_ALLOC earlier and resulted in
1669 // the direct allocation of pages.
1671 i
= (USHORT
)((NumberOfBytes
+ sizeof(POOL_HEADER
) + (POOL_BLOCK_SIZE
- 1))
1673 ASSERT(i
< POOL_LISTS_PER_PAGE
);
1676 // Handle lookaside list optimization for both paged and nonpaged pool
1678 if (i
<= NUMBER_POOL_LOOKASIDE_LISTS
)
1681 // Try popping it from the per-CPU lookaside list
1683 LookasideList
= (PoolType
== PagedPool
) ?
1684 Prcb
->PPPagedLookasideList
[i
- 1].P
:
1685 Prcb
->PPNPagedLookasideList
[i
- 1].P
;
1686 LookasideList
->TotalAllocates
++;
1687 Entry
= (PPOOL_HEADER
)InterlockedPopEntrySList(&LookasideList
->ListHead
);
1691 // We failed, try popping it from the global list
1693 LookasideList
= (PoolType
== PagedPool
) ?
1694 Prcb
->PPPagedLookasideList
[i
- 1].L
:
1695 Prcb
->PPNPagedLookasideList
[i
- 1].L
;
1696 LookasideList
->TotalAllocates
++;
1697 Entry
= (PPOOL_HEADER
)InterlockedPopEntrySList(&LookasideList
->ListHead
);
1701 // If we were able to pop it, update the accounting and return the block
1705 LookasideList
->AllocateHits
++;
1708 // Get the real entry, write down its pool type, and track it
1711 Entry
->PoolType
= OriginalType
+ 1;
1712 ExpInsertPoolTracker(Tag
,
1713 Entry
->BlockSize
* POOL_BLOCK_SIZE
,
1717 // Return the pool allocation
1719 Entry
->PoolTag
= Tag
;
1720 (POOL_FREE_BLOCK(Entry
))->Flink
= NULL
;
1721 (POOL_FREE_BLOCK(Entry
))->Blink
= NULL
;
1722 return POOL_FREE_BLOCK(Entry
);
1727 // Loop in the free lists looking for a block if this size. Start with the
1728 // list optimized for this kind of size lookup
1730 ListHead
= &PoolDesc
->ListHeads
[i
];
1734 // Are there any free entries available on this list?
1736 if (!ExpIsPoolListEmpty(ListHead
))
1739 // Acquire the pool lock now
1741 OldIrql
= ExLockPool(PoolDesc
);
1744 // And make sure the list still has entries
1746 if (ExpIsPoolListEmpty(ListHead
))
1749 // Someone raced us (and won) before we had a chance to acquire
1754 ExUnlockPool(PoolDesc
, OldIrql
);
1759 // Remove a free entry from the list
1760 // Note that due to the way we insert free blocks into multiple lists
1761 // there is a guarantee that any block on this list will either be
1762 // of the correct size, or perhaps larger.
1764 ExpCheckPoolLinks(ListHead
);
1765 Entry
= POOL_ENTRY(ExpRemovePoolHeadList(ListHead
));
1766 ExpCheckPoolLinks(ListHead
);
1767 ExpCheckPoolBlocks(Entry
);
1768 ASSERT(Entry
->BlockSize
>= i
);
1769 ASSERT(Entry
->PoolType
== 0);
1772 // Check if this block is larger that what we need. The block could
1773 // not possibly be smaller, due to the reason explained above (and
1774 // we would've asserted on a checked build if this was the case).
1776 if (Entry
->BlockSize
!= i
)
1779 // Is there an entry before this one?
1781 if (Entry
->PreviousSize
== 0)
1784 // There isn't anyone before us, so take the next block and
1785 // turn it into a fragment that contains the leftover data
1786 // that we don't need to satisfy the caller's request
1788 FragmentEntry
= POOL_BLOCK(Entry
, i
);
1789 FragmentEntry
->BlockSize
= Entry
->BlockSize
- i
;
1792 // And make it point back to us
1794 FragmentEntry
->PreviousSize
= i
;
1797 // Now get the block that follows the new fragment and check
1798 // if it's still on the same page as us (and not at the end)
1800 NextEntry
= POOL_NEXT_BLOCK(FragmentEntry
);
1801 if (PAGE_ALIGN(NextEntry
) != NextEntry
)
1804 // Adjust this next block to point to our newly created
1807 NextEntry
->PreviousSize
= FragmentEntry
->BlockSize
;
1813 // There is a free entry before us, which we know is smaller
1814 // so we'll make this entry the fragment instead
1816 FragmentEntry
= Entry
;
1819 // And then we'll remove from it the actual size required.
1820 // Now the entry is a leftover free fragment
1822 Entry
->BlockSize
-= i
;
1825 // Now let's go to the next entry after the fragment (which
1826 // used to point to our original free entry) and make it
1827 // reference the new fragment entry instead.
1829 // This is the entry that will actually end up holding the
1832 Entry
= POOL_NEXT_BLOCK(Entry
);
1833 Entry
->PreviousSize
= FragmentEntry
->BlockSize
;
1836 // And now let's go to the entry after that one and check if
1837 // it's still on the same page, and not at the end
1839 NextEntry
= POOL_BLOCK(Entry
, i
);
1840 if (PAGE_ALIGN(NextEntry
) != NextEntry
)
1843 // Make it reference the allocation entry
1845 NextEntry
->PreviousSize
= i
;
1850 // Now our (allocation) entry is the right size
1852 Entry
->BlockSize
= i
;
1855 // And the next entry is now the free fragment which contains
1856 // the remaining difference between how big the original entry
1857 // was, and the actual size the caller needs/requested.
1859 FragmentEntry
->PoolType
= 0;
1860 BlockSize
= FragmentEntry
->BlockSize
;
1863 // Now check if enough free bytes remained for us to have a
1864 // "full" entry, which contains enough bytes for a linked list
1865 // and thus can be used for allocations (up to 8 bytes...)
1867 ExpCheckPoolLinks(&PoolDesc
->ListHeads
[BlockSize
- 1]);
1871 // Insert the free entry into the free list for this size
1873 ExpInsertPoolTailList(&PoolDesc
->ListHeads
[BlockSize
- 1],
1874 POOL_FREE_BLOCK(FragmentEntry
));
1875 ExpCheckPoolLinks(POOL_FREE_BLOCK(FragmentEntry
));
1880 // We have found an entry for this allocation, so set the pool type
1881 // and release the lock since we're done
1883 Entry
->PoolType
= OriginalType
+ 1;
1884 ExpCheckPoolBlocks(Entry
);
1885 ExUnlockPool(PoolDesc
, OldIrql
);
1888 // Increment required counters
1890 InterlockedExchangeAddSizeT(&PoolDesc
->TotalBytes
, Entry
->BlockSize
* POOL_BLOCK_SIZE
);
1891 InterlockedIncrement((PLONG
)&PoolDesc
->RunningAllocs
);
1894 // Track this allocation
1896 ExpInsertPoolTracker(Tag
,
1897 Entry
->BlockSize
* POOL_BLOCK_SIZE
,
1901 // Return the pool allocation
1903 Entry
->PoolTag
= Tag
;
1904 (POOL_FREE_BLOCK(Entry
))->Flink
= NULL
;
1905 (POOL_FREE_BLOCK(Entry
))->Blink
= NULL
;
1906 return POOL_FREE_BLOCK(Entry
);
1908 } while (++ListHead
!= &PoolDesc
->ListHeads
[POOL_LISTS_PER_PAGE
]);
1911 // There were no free entries left, so we have to allocate a new fresh page
1913 Entry
= MiAllocatePoolPages(OriginalType
, PAGE_SIZE
);
1917 // Must succeed pool is deprecated, but still supported. These allocation
1918 // failures must cause an immediate bugcheck
1920 if (OriginalType
& MUST_SUCCEED_POOL_MASK
)
1922 KeBugCheckEx(MUST_SUCCEED_POOL_EMPTY
,
1924 NonPagedPoolDescriptor
.TotalPages
,
1925 NonPagedPoolDescriptor
.TotalBigPages
,
1930 // Internal debugging
1935 // This flag requests printing failures, and can also further specify
1936 // breaking on failures
1938 if (ExpPoolFlags
& POOL_FLAG_DBGPRINT_ON_FAILURE
)
1940 DPRINT1("EX: ExAllocatePool (%lu, 0x%x) returning NULL\n",
1943 if (ExpPoolFlags
& POOL_FLAG_CRASH_ON_FAILURE
) DbgBreakPoint();
1947 // Finally, this flag requests an exception, which we are more than
1950 if (OriginalType
& POOL_RAISE_IF_ALLOCATION_FAILURE
)
1952 ExRaiseStatus(STATUS_INSUFFICIENT_RESOURCES
);
1956 // Return NULL to the caller in all other cases
1962 // Setup the entry data
1965 Entry
->BlockSize
= i
;
1966 Entry
->PoolType
= OriginalType
+ 1;
1969 // This page will have two entries -- one for the allocation (which we just
1970 // created above), and one for the remaining free bytes, which we're about
1971 // to create now. The free bytes are the whole page minus what was allocated
1972 // and then converted into units of block headers.
1974 BlockSize
= (PAGE_SIZE
/ POOL_BLOCK_SIZE
) - i
;
1975 FragmentEntry
= POOL_BLOCK(Entry
, i
);
1976 FragmentEntry
->Ulong1
= 0;
1977 FragmentEntry
->BlockSize
= BlockSize
;
1978 FragmentEntry
->PreviousSize
= i
;
1981 // Increment required counters
1983 InterlockedIncrement((PLONG
)&PoolDesc
->TotalPages
);
1984 InterlockedExchangeAddSizeT(&PoolDesc
->TotalBytes
, Entry
->BlockSize
* POOL_BLOCK_SIZE
);
1987 // Now check if enough free bytes remained for us to have a "full" entry,
1988 // which contains enough bytes for a linked list and thus can be used for
1989 // allocations (up to 8 bytes...)
1991 if (FragmentEntry
->BlockSize
!= 1)
1994 // Excellent -- acquire the pool lock
1996 OldIrql
= ExLockPool(PoolDesc
);
1999 // And insert the free entry into the free list for this block size
2001 ExpCheckPoolLinks(&PoolDesc
->ListHeads
[BlockSize
- 1]);
2002 ExpInsertPoolTailList(&PoolDesc
->ListHeads
[BlockSize
- 1],
2003 POOL_FREE_BLOCK(FragmentEntry
));
2004 ExpCheckPoolLinks(POOL_FREE_BLOCK(FragmentEntry
));
2007 // Release the pool lock
2009 ExpCheckPoolBlocks(Entry
);
2010 ExUnlockPool(PoolDesc
, OldIrql
);
2015 // Simply do a sanity check
2017 ExpCheckPoolBlocks(Entry
);
2021 // Increment performance counters and track this allocation
2023 InterlockedIncrement((PLONG
)&PoolDesc
->RunningAllocs
);
2024 ExpInsertPoolTracker(Tag
,
2025 Entry
->BlockSize
* POOL_BLOCK_SIZE
,
2029 // And return the pool allocation
2031 ExpCheckPoolBlocks(Entry
);
2032 Entry
->PoolTag
= Tag
;
2033 return POOL_FREE_BLOCK(Entry
);
2041 ExAllocatePool(POOL_TYPE PoolType
,
2042 SIZE_T NumberOfBytes
)
2045 // Use a default tag of "None"
2047 return ExAllocatePoolWithTag(PoolType
, NumberOfBytes
, TAG_NONE
);
2055 ExFreePoolWithTag(IN PVOID P
,
2058 PPOOL_HEADER Entry
, NextEntry
;
2062 PPOOL_DESCRIPTOR PoolDesc
;
2064 BOOLEAN Combined
= FALSE
;
2065 PFN_NUMBER PageCount
, RealPageCount
;
2066 PKPRCB Prcb
= KeGetCurrentPrcb();
2067 PGENERAL_LOOKASIDE LookasideList
;
2071 // Check if any of the debug flags are enabled
2073 if (ExpPoolFlags
& (POOL_FLAG_CHECK_TIMERS
|
2074 POOL_FLAG_CHECK_WORKERS
|
2075 POOL_FLAG_CHECK_RESOURCES
|
2076 POOL_FLAG_VERIFIER
|
2077 POOL_FLAG_CHECK_DEADLOCK
|
2078 POOL_FLAG_SPECIAL_POOL
))
2081 // Check if special pool is enabled
2083 if (ExpPoolFlags
& POOL_FLAG_SPECIAL_POOL
)
2086 // Check if it was allocated from a special pool
2088 if (MmIsSpecialPoolAddress(P
))
2091 // Was deadlock verification also enabled? We can do some extra
2092 // checks at this point
2094 if (ExpPoolFlags
& POOL_FLAG_CHECK_DEADLOCK
)
2096 DPRINT1("Verifier not yet supported\n");
2100 // It is, so handle it via special pool free routine
2102 MmFreeSpecialPool(P
);
2108 // For non-big page allocations, we'll do a bunch of checks in here
2110 if (PAGE_ALIGN(P
) != P
)
2113 // Get the entry for this pool allocation
2114 // The pointer math here may look wrong or confusing, but it is quite right
2120 // Get the pool type
2122 PoolType
= (Entry
->PoolType
- 1) & BASE_POOL_TYPE_MASK
;
2125 // FIXME: Many other debugging checks go here
2127 ExpCheckPoolIrqlLevel(PoolType
, 0, P
);
2132 // Check if this is a big page allocation
2134 if (PAGE_ALIGN(P
) == P
)
2137 // We need to find the tag for it, so first we need to find out what
2138 // kind of allocation this was (paged or nonpaged), then we can go
2139 // ahead and try finding the tag for it. Remember to get rid of the
2140 // PROTECTED_POOL tag if it's found.
2142 // Note that if at insertion time, we failed to add the tag for a big
2143 // pool allocation, we used a special tag called 'BIG' to identify the
2144 // allocation, and we may get this tag back. In this scenario, we must
2145 // manually get the size of the allocation by actually counting through
2146 // the PFN database.
2148 PoolType
= MmDeterminePoolType(P
);
2149 ExpCheckPoolIrqlLevel(PoolType
, 0, P
);
2150 Tag
= ExpFindAndRemoveTagBigPages(P
, &PageCount
, PoolType
);
2153 DPRINT1("We do not know the size of this allocation. This is not yet supported\n");
2154 ASSERT(Tag
== ' GIB');
2155 PageCount
= 1; // We are going to lie! This might screw up accounting?
2157 else if (Tag
& PROTECTED_POOL
)
2159 Tag
&= ~PROTECTED_POOL
;
2165 if (TagToFree
&& TagToFree
!= Tag
)
2167 DPRINT1("Freeing pool - invalid tag specified: %.4s != %.4s\n", (char*)&TagToFree
, (char*)&Tag
);
2168 KeBugCheckEx(BAD_POOL_CALLER
, 0x0A, (ULONG_PTR
)P
, Tag
, TagToFree
);
2172 // We have our tag and our page count, so we can go ahead and remove this
2175 ExpRemovePoolTracker(Tag
, PageCount
<< PAGE_SHIFT
, PoolType
);
2178 // Check if any of the debug flags are enabled
2180 if (ExpPoolFlags
& (POOL_FLAG_CHECK_TIMERS
|
2181 POOL_FLAG_CHECK_WORKERS
|
2182 POOL_FLAG_CHECK_RESOURCES
|
2183 POOL_FLAG_CHECK_DEADLOCK
))
2186 // Was deadlock verification also enabled? We can do some extra
2187 // checks at this point
2189 if (ExpPoolFlags
& POOL_FLAG_CHECK_DEADLOCK
)
2191 DPRINT1("Verifier not yet supported\n");
2195 // FIXME: Many debugging checks go here
2202 PoolDesc
= PoolVector
[PoolType
];
2203 InterlockedIncrement((PLONG
)&PoolDesc
->RunningDeAllocs
);
2204 InterlockedExchangeAddSizeT(&PoolDesc
->TotalBytes
,
2205 -(LONG_PTR
)(PageCount
<< PAGE_SHIFT
));
2208 // Do the real free now and update the last counter with the big page count
2210 RealPageCount
= MiFreePoolPages(P
);
2211 ASSERT(RealPageCount
== PageCount
);
2212 InterlockedExchangeAdd((PLONG
)&PoolDesc
->TotalBigPages
,
2213 -(LONG
)RealPageCount
);
2218 // Get the entry for this pool allocation
2219 // The pointer math here may look wrong or confusing, but it is quite right
2225 // Get the size of the entry, and it's pool type, then load the descriptor
2226 // for this pool type
2228 BlockSize
= Entry
->BlockSize
;
2229 PoolType
= (Entry
->PoolType
- 1) & BASE_POOL_TYPE_MASK
;
2230 PoolDesc
= PoolVector
[PoolType
];
2233 // Make sure that the IRQL makes sense
2235 ExpCheckPoolIrqlLevel(PoolType
, 0, P
);
2238 // Get the pool tag and get rid of the PROTECTED_POOL flag
2240 Tag
= Entry
->PoolTag
;
2241 if (Tag
& PROTECTED_POOL
) Tag
&= ~PROTECTED_POOL
;
2246 if (TagToFree
&& TagToFree
!= Tag
)
2248 DPRINT1("Freeing pool - invalid tag specified: %.4s != %.4s\n", (char*)&TagToFree
, (char*)&Tag
);
2249 KeBugCheckEx(BAD_POOL_CALLER
, 0x0A, (ULONG_PTR
)P
, Tag
, TagToFree
);
2253 // Track the removal of this allocation
2255 ExpRemovePoolTracker(Tag
,
2256 BlockSize
* POOL_BLOCK_SIZE
,
2257 Entry
->PoolType
- 1);
2260 // Release pool quota, if any
2262 if ((Entry
->PoolType
- 1) & QUOTA_POOL_MASK
)
2264 Process
= ((PVOID
*)POOL_NEXT_BLOCK(Entry
))[-1];
2265 ASSERT(Process
!= NULL
);
2268 if (Process
->Pcb
.Header
.Type
!= ProcessObject
)
2270 DPRINT1("Object %p is not a process. Type %u, pool type 0x%x, block size %u\n",
2271 Process
, Process
->Pcb
.Header
.Type
, Entry
->PoolType
, BlockSize
);
2272 KeBugCheckEx(BAD_POOL_CALLER
,
2276 (ULONG_PTR
)Process
);
2278 PsReturnPoolQuota(Process
, PoolType
, BlockSize
* POOL_BLOCK_SIZE
);
2279 ObDereferenceObject(Process
);
2284 // Is this allocation small enough to have come from a lookaside list?
2286 if (BlockSize
<= NUMBER_POOL_LOOKASIDE_LISTS
)
2289 // Try pushing it into the per-CPU lookaside list
2291 LookasideList
= (PoolType
== PagedPool
) ?
2292 Prcb
->PPPagedLookasideList
[BlockSize
- 1].P
:
2293 Prcb
->PPNPagedLookasideList
[BlockSize
- 1].P
;
2294 LookasideList
->TotalFrees
++;
2295 if (ExQueryDepthSList(&LookasideList
->ListHead
) < LookasideList
->Depth
)
2297 LookasideList
->FreeHits
++;
2298 InterlockedPushEntrySList(&LookasideList
->ListHead
, P
);
2303 // We failed, try to push it into the global lookaside list
2305 LookasideList
= (PoolType
== PagedPool
) ?
2306 Prcb
->PPPagedLookasideList
[BlockSize
- 1].L
:
2307 Prcb
->PPNPagedLookasideList
[BlockSize
- 1].L
;
2308 LookasideList
->TotalFrees
++;
2309 if (ExQueryDepthSList(&LookasideList
->ListHead
) < LookasideList
->Depth
)
2311 LookasideList
->FreeHits
++;
2312 InterlockedPushEntrySList(&LookasideList
->ListHead
, P
);
2318 // Get the pointer to the next entry
2320 NextEntry
= POOL_BLOCK(Entry
, BlockSize
);
2323 // Update performance counters
2325 InterlockedIncrement((PLONG
)&PoolDesc
->RunningDeAllocs
);
2326 InterlockedExchangeAddSizeT(&PoolDesc
->TotalBytes
, -BlockSize
* POOL_BLOCK_SIZE
);
2329 // Acquire the pool lock
2331 OldIrql
= ExLockPool(PoolDesc
);
2334 // Check if the next allocation is at the end of the page
2336 ExpCheckPoolBlocks(Entry
);
2337 if (PAGE_ALIGN(NextEntry
) != NextEntry
)
2340 // We may be able to combine the block if it's free
2342 if (NextEntry
->PoolType
== 0)
2345 // The next block is free, so we'll do a combine
2350 // Make sure there's actual data in the block -- anything smaller
2351 // than this means we only have the header, so there's no linked list
2354 if ((NextEntry
->BlockSize
!= 1))
2357 // The block is at least big enough to have a linked list, so go
2358 // ahead and remove it
2360 ExpCheckPoolLinks(POOL_FREE_BLOCK(NextEntry
));
2361 ExpRemovePoolEntryList(POOL_FREE_BLOCK(NextEntry
));
2362 ExpCheckPoolLinks(ExpDecodePoolLink((POOL_FREE_BLOCK(NextEntry
))->Flink
));
2363 ExpCheckPoolLinks(ExpDecodePoolLink((POOL_FREE_BLOCK(NextEntry
))->Blink
));
2367 // Our entry is now combined with the next entry
2369 Entry
->BlockSize
= Entry
->BlockSize
+ NextEntry
->BlockSize
;
2374 // Now check if there was a previous entry on the same page as us
2376 if (Entry
->PreviousSize
)
2379 // Great, grab that entry and check if it's free
2381 NextEntry
= POOL_PREV_BLOCK(Entry
);
2382 if (NextEntry
->PoolType
== 0)
2385 // It is, so we can do a combine
2390 // Make sure there's actual data in the block -- anything smaller
2391 // than this means we only have the header so there's no linked list
2394 if ((NextEntry
->BlockSize
!= 1))
2397 // The block is at least big enough to have a linked list, so go
2398 // ahead and remove it
2400 ExpCheckPoolLinks(POOL_FREE_BLOCK(NextEntry
));
2401 ExpRemovePoolEntryList(POOL_FREE_BLOCK(NextEntry
));
2402 ExpCheckPoolLinks(ExpDecodePoolLink((POOL_FREE_BLOCK(NextEntry
))->Flink
));
2403 ExpCheckPoolLinks(ExpDecodePoolLink((POOL_FREE_BLOCK(NextEntry
))->Blink
));
2407 // Combine our original block (which might've already been combined
2408 // with the next block), into the previous block
2410 NextEntry
->BlockSize
= NextEntry
->BlockSize
+ Entry
->BlockSize
;
2413 // And now we'll work with the previous block instead
2420 // By now, it may have been possible for our combined blocks to actually
2421 // have made up a full page (if there were only 2-3 allocations on the
2422 // page, they could've all been combined).
2424 if ((PAGE_ALIGN(Entry
) == Entry
) &&
2425 (PAGE_ALIGN(POOL_NEXT_BLOCK(Entry
)) == POOL_NEXT_BLOCK(Entry
)))
2428 // In this case, release the pool lock, update the performance counter,
2429 // and free the page
2431 ExUnlockPool(PoolDesc
, OldIrql
);
2432 InterlockedExchangeAdd((PLONG
)&PoolDesc
->TotalPages
, -1);
2433 MiFreePoolPages(Entry
);
2438 // Otherwise, we now have a free block (or a combination of 2 or 3)
2440 Entry
->PoolType
= 0;
2441 BlockSize
= Entry
->BlockSize
;
2442 ASSERT(BlockSize
!= 1);
2445 // Check if we actually did combine it with anyone
2450 // Get the first combined block (either our original to begin with, or
2451 // the one after the original, depending if we combined with the previous)
2453 NextEntry
= POOL_NEXT_BLOCK(Entry
);
2456 // As long as the next block isn't on a page boundary, have it point
2459 if (PAGE_ALIGN(NextEntry
) != NextEntry
) NextEntry
->PreviousSize
= BlockSize
;
2463 // Insert this new free block, and release the pool lock
2465 ExpInsertPoolHeadList(&PoolDesc
->ListHeads
[BlockSize
- 1], POOL_FREE_BLOCK(Entry
));
2466 ExpCheckPoolLinks(POOL_FREE_BLOCK(Entry
));
2467 ExUnlockPool(PoolDesc
, OldIrql
);
2478 // Just free without checking for the tag
2480 ExFreePoolWithTag(P
, 0);
2488 ExQueryPoolBlockSize(IN PVOID PoolBlock
,
2489 OUT PBOOLEAN QuotaCharged
)
2504 ExAllocatePoolWithQuota(IN POOL_TYPE PoolType
,
2505 IN SIZE_T NumberOfBytes
)
2508 // Allocate the pool
2510 return ExAllocatePoolWithQuotaTag(PoolType
, NumberOfBytes
, 'enoN');
2518 ExAllocatePoolWithTagPriority(IN POOL_TYPE PoolType
,
2519 IN SIZE_T NumberOfBytes
,
2521 IN EX_POOL_PRIORITY Priority
)
2524 // Allocate the pool
2527 return ExAllocatePoolWithTag(PoolType
, NumberOfBytes
, Tag
);
2535 ExAllocatePoolWithQuotaTag(IN POOL_TYPE PoolType
,
2536 IN SIZE_T NumberOfBytes
,
2539 BOOLEAN Raise
= TRUE
;
2543 PEPROCESS Process
= PsGetCurrentProcess();
2546 // Check if we should fail instead of raising an exception
2548 if (PoolType
& POOL_QUOTA_FAIL_INSTEAD_OF_RAISE
)
2551 PoolType
&= ~POOL_QUOTA_FAIL_INSTEAD_OF_RAISE
;
2555 // Inject the pool quota mask
2557 PoolType
+= QUOTA_POOL_MASK
;
2560 // Check if we have enough space to add the quota owner process, as long as
2561 // this isn't the system process, which never gets charged quota
2563 ASSERT(NumberOfBytes
!= 0);
2564 if ((NumberOfBytes
<= (PAGE_SIZE
- POOL_BLOCK_SIZE
- sizeof(PVOID
))) &&
2565 (Process
!= PsInitialSystemProcess
))
2568 // Add space for our EPROCESS pointer
2570 NumberOfBytes
+= sizeof(PEPROCESS
);
2575 // We won't be able to store the pointer, so don't use quota for this
2577 PoolType
-= QUOTA_POOL_MASK
;
2581 // Allocate the pool buffer now
2583 Buffer
= ExAllocatePoolWithTag(PoolType
, NumberOfBytes
, Tag
);
2586 // If the buffer is page-aligned, this is a large page allocation and we
2589 if (PAGE_ALIGN(Buffer
) != Buffer
)
2592 // Also if special pool is enabled, and this was allocated from there,
2593 // we won't touch it either
2595 if ((ExpPoolFlags
& POOL_FLAG_SPECIAL_POOL
) &&
2596 (MmIsSpecialPoolAddress(Buffer
)))
2602 // If it wasn't actually allocated with quota charges, ignore it too
2604 if (!(PoolType
& QUOTA_POOL_MASK
)) return Buffer
;
2607 // If this is the system process, we don't charge quota, so ignore
2609 if (Process
== PsInitialSystemProcess
) return Buffer
;
2612 // Actually go and charge quota for the process now
2614 Entry
= POOL_ENTRY(Buffer
);
2615 Status
= PsChargeProcessPoolQuota(Process
,
2616 PoolType
& BASE_POOL_TYPE_MASK
,
2617 Entry
->BlockSize
* POOL_BLOCK_SIZE
);
2618 if (!NT_SUCCESS(Status
))
2621 // Quota failed, back out the allocation, clear the owner, and fail
2623 ((PVOID
*)POOL_NEXT_BLOCK(Entry
))[-1] = NULL
;
2624 ExFreePoolWithTag(Buffer
, Tag
);
2625 if (Raise
) RtlRaiseStatus(Status
);
2630 // Quota worked, write the owner and then reference it before returning
2632 ((PVOID
*)POOL_NEXT_BLOCK(Entry
))[-1] = Process
;
2633 ObReferenceObject(Process
);
2635 else if (!(Buffer
) && (Raise
))
2638 // The allocation failed, raise an error if we are in raise mode
2640 RtlRaiseStatus(STATUS_INSUFFICIENT_RESOURCES
);
2644 // Return the allocated buffer
2656 ULONG_PTR Address
= 0, Flags
= 0;
2665 if (!KdbpGetHexNumber(Argv
[1], &Address
))
2667 KdbpPrint("Invalid parameter: %s\n", Argv
[0]);
2675 if (!KdbpGetHexNumber(Argv
[1], &Flags
))
2677 KdbpPrint("Invalid parameter: %s\n", Argv
[0]);
2682 /* Check if we got an address */
2685 /* Get the base page */
2686 PoolPage
= PAGE_ALIGN(Address
);
2690 KdbpPrint("Heap is unimplemented\n");
2694 /* No paging support! */
2695 if (!MmIsAddressValid(PoolPage
))
2697 KdbpPrint("Address not accessible!\n");
2702 if ((Address
>= (ULONG_PTR
)MmPagedPoolStart
) && (Address
<= (ULONG_PTR
)MmPagedPoolEnd
))
2703 KdbpPrint("Allocation is from PagedPool region\n");
2704 else if ((Address
>= (ULONG_PTR
)MmNonPagedPoolStart
) && (Address
<= (ULONG_PTR
)MmNonPagedPoolEnd
))
2705 KdbpPrint("Allocation is from NonPagedPool region\n");
2708 KdbpPrint("Address 0x%p is not within any pool!\n", (PVOID
)Address
);
2712 /* Loop all entries of that page */
2716 /* Check if the address is within that entry */
2717 ThisOne
= ((Address
>= (ULONG_PTR
)Entry
) &&
2718 (Address
< (ULONG_PTR
)(Entry
+ Entry
->BlockSize
)));
2720 if (!(Flags
& 1) || ThisOne
)
2722 /* Print the line */
2723 KdbpPrint("%c%p size: %4d previous size: %4d %s %.4s\n",
2724 ThisOne
? '*' : ' ', Entry
, Entry
->BlockSize
, Entry
->PreviousSize
,
2725 (Flags
& 0x80000000) ? "" : (Entry
->PoolType
? "(Allocated)" : "(Free) "),
2726 (Flags
& 0x80000000) ? "" : (PCHAR
)&Entry
->PoolTag
);
2731 Data
= (PULONG
)(Entry
+ 1);
2732 KdbpPrint(" %p %08lx %08lx %08lx %08lx\n"
2733 " %p %08lx %08lx %08lx %08lx\n",
2734 &Data
[0], Data
[0], Data
[1], Data
[2], Data
[3],
2735 &Data
[4], Data
[4], Data
[5], Data
[6], Data
[7]);
2738 /* Go to next entry */
2739 Entry
= POOL_BLOCK(Entry
, Entry
->BlockSize
);
2741 while ((Entry
->BlockSize
!= 0) && ((ULONG_PTR
)Entry
< (ULONG_PTR
)PoolPage
+ PAGE_SIZE
));
2746 #endif // DBG && KDBG