2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS kernel
4 * FILE: ntoskrnl/rtl/libsupp.c
5 * PURPOSE: RTL Support Routines
6 * PROGRAMMERS: Alex Ionescu (alex@relsoft.net)
10 /* INCLUDES ******************************************************************/
16 #define TAG_ATMT 'TotA' /* Atom table */
18 extern ULONG NtGlobalFlag
;
20 typedef struct _RTL_RANGE_ENTRY
24 } RTL_RANGE_ENTRY
, *PRTL_RANGE_ENTRY
;
26 PAGED_LOOKASIDE_LIST RtlpRangeListEntryLookasideList
;
27 SIZE_T RtlpAllocDeallocQueryBufferSize
= 128;
29 /* FUNCTIONS *****************************************************************/
35 OUT PVOID
*BaseOfImage
)
37 PLDR_DATA_TABLE_ENTRY LdrEntry
;
40 /* Get the base for this file */
41 if ((ULONG_PTR
)PcValue
> (ULONG_PTR
)MmHighestUserAddress
)
43 /* We are in kernel */
44 *BaseOfImage
= KiPcToFileHeader(PcValue
, &LdrEntry
, FALSE
, &InSystem
);
48 /* We are in user land */
49 *BaseOfImage
= KiRosPcToUserFileHeader(PcValue
, &LdrEntry
);
57 RtlInitializeRangeListPackage(VOID
)
59 /* Setup the lookaside list for allocations (not used yet) */
60 ExInitializePagedLookasideList(&RtlpRangeListEntryLookasideList
,
64 sizeof(RTL_RANGE_ENTRY
),
71 RtlpCheckForActiveDebugger(VOID
)
73 /* This check is meaningless in kernel-mode */
79 RtlpSetInDbgPrint(VOID
)
81 /* Nothing to set in kernel mode */
87 RtlpClearInDbgPrint(VOID
)
89 /* Nothing to clear in kernel mode */
101 RtlpAllocateMemory(ULONG Bytes
,
104 return ExAllocatePoolWithTag(PagedPool
,
110 #define TAG_USTR 'RTSU'
111 #define TAG_ASTR 'RTSA'
112 #define TAG_OSTR 'RTSO'
115 RtlpFreeMemory(PVOID Mem
,
118 if (Tag
== TAG_ASTR
|| Tag
== TAG_OSTR
|| Tag
== TAG_USTR
)
121 ExFreePoolWithTag(Mem
, Tag
);
128 RtlAcquirePebLock(VOID
)
137 RtlReleasePebLock(VOID
)
144 LdrShutdownThread(VOID
)
146 return STATUS_SUCCESS
;
152 RtlGetCurrentPeb(VOID
)
154 return ((PEPROCESS
)(KeGetCurrentThread()->ApcState
.Process
))->Peb
;
159 RtlDeleteHeapLock(IN OUT PHEAP_LOCK Lock
)
161 ExDeleteResourceLite(&Lock
->Resource
);
164 return STATUS_SUCCESS
;
169 RtlEnterHeapLock(IN OUT PHEAP_LOCK Lock
, IN BOOLEAN Exclusive
)
171 KeEnterCriticalRegion();
174 ExAcquireResourceExclusiveLite(&Lock
->Resource
, TRUE
);
176 ExAcquireResourceSharedLite(&Lock
->Resource
, TRUE
);
178 return STATUS_SUCCESS
;
183 RtlInitializeHeapLock(IN OUT PHEAP_LOCK
*Lock
)
185 PHEAP_LOCK HeapLock
= ExAllocatePool(NonPagedPool
, sizeof(HEAP_LOCK
));
186 if (HeapLock
== NULL
)
187 return STATUS_NO_MEMORY
;
189 ExInitializeResourceLite(&HeapLock
->Resource
);
192 return STATUS_SUCCESS
;
197 RtlLeaveHeapLock(IN OUT PHEAP_LOCK Lock
)
199 ExReleaseResourceLite(&Lock
->Resource
);
200 KeLeaveCriticalRegion();
202 return STATUS_SUCCESS
;
209 RtlpAddHeapToProcessList(struct _HEAP
*Heap
)
211 UNREFERENCED_PARAMETER(Heap
);
216 RtlpRemoveHeapFromProcessList(struct _HEAP
*Heap
)
218 UNREFERENCED_PARAMETER(Heap
);
222 RtlInitializeHeapManager(VOID
)
228 CHECK_PAGED_CODE_RTL(char *file
, int line
)
230 if(KeGetCurrentIrql() > APC_LEVEL
)
232 DbgPrint("%s:%i: Pagable code called at IRQL > APC_LEVEL (%d)\n", file
, line
, KeGetCurrentIrql());
240 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
241 IN PCONTEXT ContextRecord
,
242 IN PVOID ContextData
,
245 /* Check the global flag */
246 if (NtGlobalFlag
& FLG_ENABLE_EXCEPTION_LOGGING
)
248 /* FIXME: Log this exception */
254 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
255 IN ULONG_PTR RegistrationFrameEnd
,
256 IN OUT PULONG_PTR StackLow
,
257 IN OUT PULONG_PTR StackHigh
)
262 /* Check if we are at DISPATCH or higher */
263 if (KeGetCurrentIrql() >= DISPATCH_LEVEL
)
265 /* Get the PRCB and DPC Stack */
266 Prcb
= KeGetCurrentPrcb();
267 DpcStack
= (ULONG_PTR
)Prcb
->DpcStack
;
269 /* Check if we are in a DPC and the stack matches */
270 if ((Prcb
->DpcRoutineActive
) &&
271 (RegistrationFrameEnd
<= DpcStack
) &&
272 ((ULONG_PTR
)RegistrationFrame
>= DpcStack
- KERNEL_STACK_SIZE
))
274 /* Update the limits to the DPC Stack's */
275 *StackHigh
= DpcStack
;
276 *StackLow
= DpcStack
- KERNEL_STACK_SIZE
;
281 /* Not in DPC stack */
285 #if !defined(_ARM_) && !defined(_AMD64_)
289 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
290 IN ULONG_PTR
*StackBegin
,
291 IN ULONG_PTR
*StackEnd
)
293 PKTHREAD Thread
= KeGetCurrentThread();
295 /* Don't even try at ISR level or later */
296 if (KeGetCurrentIrql() > DISPATCH_LEVEL
) return FALSE
;
298 /* Start with defaults */
299 *StackBegin
= Thread
->StackLimit
;
300 *StackEnd
= (ULONG_PTR
)Thread
->StackBase
;
302 /* Check if EBP is inside the stack */
303 if ((*StackBegin
<= Ebp
) && (Ebp
<= *StackEnd
))
305 /* Then make the stack start at EBP */
310 /* Now we're going to assume we're on the DPC stack */
311 *StackEnd
= (ULONG_PTR
)(KeGetPcr()->Prcb
->DpcStack
);
312 *StackBegin
= *StackEnd
- KERNEL_STACK_SIZE
;
314 /* Check if we seem to be on the DPC stack */
315 if ((*StackEnd
) && (*StackBegin
< Ebp
) && (Ebp
<= *StackEnd
))
317 /* We're on the DPC stack */
322 /* We're somewhere else entirely... use EBP for safety */
324 *StackEnd
= (ULONG_PTR
)PAGE_ALIGN(*StackBegin
);
337 RtlWalkFrameChain(OUT PVOID
*Callers
,
341 ULONG_PTR Stack
, NewStack
, StackBegin
, StackEnd
= 0;
343 BOOLEAN Result
, StopSearch
= FALSE
;
345 PETHREAD Thread
= PsGetCurrentThread();
347 PKTRAP_FRAME TrapFrame
;
349 /* Get current EBP */
352 __asm__("mov %%ebp, %0" : "=r" (Stack
) : );
353 #elif defined(_MSC_VER)
356 #elif defined(_M_MIPS)
357 __asm__("move $sp, %0" : "=r" (Stack
) : );
358 #elif defined(_M_PPC)
359 __asm__("mr %0,1" : "=r" (Stack
) : );
360 #elif defined(_M_ARM)
361 __asm__("mov sp, %0" : "=r"(Stack
) : );
363 #error Unknown architecture
366 /* Set it as the stack begin limit as well */
367 StackBegin
= (ULONG_PTR
)Stack
;
369 /* Check if we're called for non-logging mode */
372 /* Get the actual safe limits */
373 Result
= RtlpCaptureStackLimits((ULONG_PTR
)Stack
,
376 if (!Result
) return 0;
379 /* Use a SEH block for maximum protection */
382 /* Check if we want the user-mode stack frame */
385 /* Get the trap frame and TEB */
386 TrapFrame
= KeGetTrapFrame(&Thread
->Tcb
);
387 Teb
= Thread
->Tcb
.Teb
;
389 /* Make sure we can trust the TEB and trap frame */
391 (KeIsAttachedProcess()) ||
392 (KeGetCurrentIrql() >= DISPATCH_LEVEL
))
394 /* Invalid or unsafe attempt to get the stack */
395 _SEH2_YIELD(return 0;)
398 /* Get the stack limits */
399 StackBegin
= (ULONG_PTR
)Teb
->NtTib
.StackLimit
;
400 StackEnd
= (ULONG_PTR
)Teb
->NtTib
.StackBase
;
402 Stack
= TrapFrame
->Ebp
;
403 #elif defined(_M_PPC)
404 Stack
= TrapFrame
->Gpr1
;
406 #error Unknown architecture
410 if (StackEnd
<= StackBegin
) return 0;
411 ProbeForRead((PVOID
)StackBegin
,
412 StackEnd
- StackBegin
,
416 /* Loop the frames */
417 for (i
= 0; i
< Count
; i
++)
420 * Leave if we're past the stack,
421 * if we're before the stack,
422 * or if we've reached ourselves.
424 if ((Stack
>= StackEnd
) ||
425 (!i
? (Stack
< StackBegin
) : (Stack
<= StackBegin
)) ||
426 ((StackEnd
- Stack
) < (2 * sizeof(ULONG_PTR
))))
428 /* We're done or hit a bad address */
432 /* Get new stack and EIP */
433 NewStack
= *(PULONG_PTR
)Stack
;
434 Eip
= *(PULONG_PTR
)(Stack
+ sizeof(ULONG_PTR
));
436 /* Check if the new pointer is above the oldone and past the end */
437 if (!((Stack
< NewStack
) && (NewStack
< StackEnd
)))
439 /* Stop searching after this entry */
443 /* Also make sure that the EIP isn't a stack address */
444 if ((StackBegin
< Eip
) && (Eip
< StackEnd
)) break;
446 /* Check if we reached a user-mode address */
447 if (!(Flags
) && !(Eip
& 0x80000000)) break; // FIXME: 3GB breakage
449 /* Save this frame */
450 Callers
[i
] = (PVOID
)Eip
;
452 /* Check if we should continue */
455 /* Return the next index */
460 /* Move to the next stack */
464 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
471 /* Return frames parsed */
481 OUT PULONG_PTR LowLimit
,
482 OUT PULONG_PTR HighLimit
)
484 PKTHREAD CurrentThread
= KeGetCurrentThread();
485 *HighLimit
= (ULONG_PTR
)CurrentThread
->InitialStack
;
486 *LowLimit
= (ULONG_PTR
)CurrentThread
->StackLimit
;
490 /* RTL Atom Tables ************************************************************/
493 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
495 ExInitializeFastMutex(&AtomTable
->FastMutex
);
497 return STATUS_SUCCESS
;
502 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
508 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
510 ExAcquireFastMutex(&AtomTable
->FastMutex
);
515 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
517 ExReleaseFastMutex(&AtomTable
->FastMutex
);
521 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
523 AtomTable
->ExHandleTable
= ExCreateHandleTable(NULL
);
524 return (AtomTable
->ExHandleTable
!= NULL
);
528 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
530 if (AtomTable
->ExHandleTable
)
532 ExSweepHandleTable(AtomTable
->ExHandleTable
,
535 ExDestroyHandleTable(AtomTable
->ExHandleTable
, NULL
);
536 AtomTable
->ExHandleTable
= NULL
;
541 RtlpAllocAtomTable(ULONG Size
)
543 PRTL_ATOM_TABLE Table
= ExAllocatePool(NonPagedPool
,
555 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
557 ExFreePool(AtomTable
);
560 PRTL_ATOM_TABLE_ENTRY
561 RtlpAllocAtomTableEntry(ULONG Size
)
563 PRTL_ATOM_TABLE_ENTRY Entry
;
565 Entry
= ExAllocatePoolWithTag(NonPagedPool
, Size
, TAG_ATMT
);
568 RtlZeroMemory(Entry
, Size
);
575 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
577 ExFreePoolWithTag(Entry
, TAG_ATMT
);
581 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
583 ExDestroyHandle(AtomTable
->ExHandleTable
,
584 (HANDLE
)((ULONG_PTR
)Entry
->HandleIndex
<< 2),
589 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
591 HANDLE_TABLE_ENTRY ExEntry
;
595 /* Initialize ex handle table entry */
596 ExEntry
.Object
= Entry
;
597 ExEntry
.GrantedAccess
= 0x1; /* FIXME - valid handle */
599 /* Create ex handle */
600 Handle
= ExCreateHandle(AtomTable
->ExHandleTable
,
602 if (!Handle
) return FALSE
;
604 /* Calculate HandleIndex (by getting rid of the first two bits) */
605 HandleIndex
= (USHORT
)((ULONG_PTR
)Handle
>> 2);
607 /* Index must be less than 0xC000 */
608 if (HandleIndex
>= 0xC000)
610 /* Destroy ex handle */
611 ExDestroyHandle(AtomTable
->ExHandleTable
,
619 /* Initialize atom table entry */
620 Entry
->HandleIndex
= HandleIndex
;
621 Entry
->Atom
= 0xC000 + HandleIndex
;
627 PRTL_ATOM_TABLE_ENTRY
628 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
630 PHANDLE_TABLE_ENTRY ExEntry
;
631 PRTL_ATOM_TABLE_ENTRY Entry
= NULL
;
633 /* NOTE: There's no need to explicitly enter a critical region because it's
634 guaranteed that we're in a critical region right now (as we hold
635 the atom table lock) */
637 ExEntry
= ExMapHandleToPointer(AtomTable
->ExHandleTable
,
638 (HANDLE
)((ULONG_PTR
)Index
<< 2));
641 Entry
= ExEntry
->Object
;
643 ExUnlockHandleTableEntry(AtomTable
->ExHandleTable
,
651 * Ldr Resource support code
654 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
655 LPCWSTR name
, void *root
,
657 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
658 USHORT id
, void *root
, int want_dir
);
659 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
660 void *root
, int want_dir
);
662 /**********************************************************************
665 * Find a resource entry
667 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
668 ULONG level
, void **ret
, int want_dir
)
672 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
674 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
675 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
678 if (!level
--) goto done
;
679 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
680 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
681 if (!level
--) return STATUS_SUCCESS
;
684 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
685 return STATUS_RESOURCE_NAME_NOT_FOUND
;
686 if (!level
--) return STATUS_SUCCESS
;
687 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
691 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
693 return STATUS_RESOURCE_DATA_NOT_FOUND
;
697 return STATUS_SUCCESS
;
703 _Out_writes_bytes_all_(Length
) VOID UNALIGNED
*Destination
,
704 _In_reads_bytes_(Length
) CONST VOID UNALIGNED
*Source
,
709 RtlCopyMemory(Destination
, Source
, Length
);
711 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
713 _SEH2_YIELD(return _SEH2_GetExceptionCode());
717 return STATUS_SUCCESS
;
722 RtlCallVectoredExceptionHandlers(
723 _In_ PEXCEPTION_RECORD ExceptionRecord
,
724 _In_ PCONTEXT Context
)
726 /* In the kernel we don't have vectored exception handlers */