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 *****************************************************************/
33 RtlInitializeRangeListPackage(VOID
)
35 /* Setup the lookaside list for allocations (not used yet) */
36 ExInitializePagedLookasideList(&RtlpRangeListEntryLookasideList
,
40 sizeof(RTL_RANGE_ENTRY
),
47 RtlpCheckForActiveDebugger(BOOLEAN Type
)
49 /* This check is meaningless in kernel-mode */
55 RtlpSetInDbgPrint(IN BOOLEAN NewValue
)
57 /* This check is meaningless in kernel-mode */
70 RtlpAllocateMemory(ULONG Bytes
,
73 return ExAllocatePoolWithTag(PagedPool
,
79 #define TAG_USTR 'RTSU'
80 #define TAG_ASTR 'RTSA'
81 #define TAG_OSTR 'RTSO'
84 RtlpFreeMemory(PVOID Mem
,
87 if (Tag
== TAG_ASTR
|| Tag
== TAG_OSTR
|| Tag
== TAG_USTR
)
90 ExFreePoolWithTag(Mem
, Tag
);
97 RtlAcquirePebLock(VOID
)
106 RtlReleasePebLock(VOID
)
113 LdrShutdownThread(VOID
)
115 return STATUS_SUCCESS
;
121 RtlGetCurrentPeb(VOID
)
123 return ((PEPROCESS
)(KeGetCurrentThread()->ApcState
.Process
))->Peb
;
129 PRTL_CRITICAL_SECTION CriticalSection
)
132 return STATUS_SUCCESS
;
138 PRTL_CRITICAL_SECTION CriticalSection
)
141 return STATUS_SUCCESS
;
146 RtlInitializeHeapLock(
147 PRTL_CRITICAL_SECTION CriticalSection
)
150 return STATUS_SUCCESS
;
156 PRTL_CRITICAL_SECTION CriticalSection
)
159 return STATUS_SUCCESS
;
164 CHECK_PAGED_CODE_RTL(char *file
, int line
)
166 if(KeGetCurrentIrql() > APC_LEVEL
)
168 DbgPrint("%s:%i: Pagable code called at IRQL > APC_LEVEL (%d)\n", file
, line
, KeGetCurrentIrql());
176 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
177 IN PCONTEXT ContextRecord
,
178 IN PVOID ContextData
,
181 /* Check the global flag */
182 if (NtGlobalFlag
& FLG_ENABLE_EXCEPTION_LOGGING
)
184 /* FIXME: Log this exception */
190 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
191 IN ULONG_PTR RegistrationFrameEnd
,
192 IN OUT PULONG_PTR StackLow
,
193 IN OUT PULONG_PTR StackHigh
)
198 /* Check if we are at DISPATCH or higher */
199 if (KeGetCurrentIrql() >= DISPATCH_LEVEL
)
201 /* Get the PRCB and DPC Stack */
202 Prcb
= KeGetCurrentPrcb();
203 DpcStack
= (ULONG_PTR
)Prcb
->DpcStack
;
205 /* Check if we are in a DPC and the stack matches */
206 if ((Prcb
->DpcRoutineActive
) &&
207 (RegistrationFrameEnd
<= DpcStack
) &&
208 ((ULONG_PTR
)RegistrationFrame
>= DpcStack
- KERNEL_STACK_SIZE
))
210 /* Update the limits to the DPC Stack's */
211 *StackHigh
= DpcStack
;
212 *StackLow
= DpcStack
- KERNEL_STACK_SIZE
;
217 /* Not in DPC stack */
225 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
226 IN ULONG_PTR
*StackBegin
,
227 IN ULONG_PTR
*StackEnd
)
229 PKTHREAD Thread
= KeGetCurrentThread();
231 /* Don't even try at ISR level or later */
232 if (KeGetCurrentIrql() > DISPATCH_LEVEL
) return FALSE
;
234 /* Start with defaults */
235 *StackBegin
= Thread
->StackLimit
;
236 *StackEnd
= (ULONG_PTR
)Thread
->StackBase
;
238 /* Check if EBP is inside the stack */
239 if ((*StackBegin
<= Ebp
) && (Ebp
<= *StackEnd
))
241 /* Then make the stack start at EBP */
246 /* Now we're going to assume we're on the DPC stack */
247 *StackEnd
= (ULONG_PTR
)(KeGetPcr()->Prcb
->DpcStack
);
248 *StackBegin
= *StackEnd
- KERNEL_STACK_SIZE
;
250 /* Check if we seem to be on the DPC stack */
251 if ((*StackEnd
) && (*StackBegin
< Ebp
) && (Ebp
<= *StackEnd
))
253 /* We're on the DPC stack */
258 /* We're somewhere else entirely... use EBP for safety */
260 *StackEnd
= (ULONG_PTR
)PAGE_ALIGN(*StackBegin
);
273 RtlWalkFrameChain(OUT PVOID
*Callers
,
277 ULONG_PTR Stack
, NewStack
, StackBegin
, StackEnd
= 0;
279 BOOLEAN Result
, StopSearch
= FALSE
;
281 PKTHREAD Thread
= KeGetCurrentThread();
283 PKTRAP_FRAME TrapFrame
;
285 /* Get current EBP */
288 __asm__("mov %%ebp, %0" : "=r" (Stack
) : );
289 #elif defined(_MSC_VER)
292 #elif defined(_M_MIPS)
293 __asm__("move $sp, %0" : "=r" (Stack
) : );
294 #elif defined(_M_PPC)
295 __asm__("mr %0,1" : "=r" (Stack
) : );
296 #elif defined(_M_ARM)
297 __asm__("mov sp, %0" : "=r"(Stack
) : );
299 #error Unknown architecture
302 /* Set it as the stack begin limit as well */
303 StackBegin
= (ULONG_PTR
)Stack
;
305 /* Check if we're called for non-logging mode */
308 /* Get the actual safe limits */
309 Result
= RtlpCaptureStackLimits((ULONG_PTR
)Stack
,
312 if (!Result
) return 0;
315 /* Use a SEH block for maximum protection */
318 /* Check if we want the user-mode stack frame */
321 /* Get the trap frame and TEB */
322 TrapFrame
= Thread
->TrapFrame
;
325 /* Make sure we can trust the TEB and trap frame */
327 !((PVOID
)((ULONG_PTR
)TrapFrame
& 0x80000000)) ||
328 ((PVOID
)TrapFrame
<= (PVOID
)Thread
->StackLimit
) ||
329 ((PVOID
)TrapFrame
>= (PVOID
)Thread
->StackBase
) ||
330 (KeIsAttachedProcess()) ||
331 (KeGetCurrentIrql() >= DISPATCH_LEVEL
))
333 /* Invalid or unsafe attempt to get the stack */
337 /* Get the stack limits */
338 StackBegin
= (ULONG_PTR
)Teb
->Tib
.StackLimit
;
339 StackEnd
= (ULONG_PTR
)Teb
->Tib
.StackBase
;
341 Stack
= TrapFrame
->Ebp
;
342 #elif defined(_M_PPC)
343 Stack
= TrapFrame
->Gpr1
;
345 #error Unknown architecture
349 if (StackEnd
<= StackBegin
) return 0;
350 ProbeForRead((PVOID
)StackBegin
,
351 StackEnd
- StackBegin
,
355 /* Loop the frames */
356 for (i
= 0; i
< Count
; i
++)
359 * Leave if we're past the stack,
360 * if we're before the stack,
361 * or if we've reached ourselves.
363 if ((Stack
>= StackEnd
) ||
364 (!i
? (Stack
< StackBegin
) : (Stack
<= StackBegin
)) ||
365 ((StackEnd
- Stack
) < (2 * sizeof(ULONG_PTR
))))
367 /* We're done or hit a bad address */
371 /* Get new stack and EIP */
372 NewStack
= *(PULONG_PTR
)Stack
;
373 Eip
= *(PULONG_PTR
)(Stack
+ sizeof(ULONG_PTR
));
375 /* Check if the new pointer is above the oldone and past the end */
376 if (!((Stack
< NewStack
) && (NewStack
< StackEnd
)))
378 /* Stop searching after this entry */
382 /* Also make sure that the EIP isn't a stack address */
383 if ((StackBegin
< Eip
) && (Eip
< StackEnd
)) break;
385 /* Check if we reached a user-mode address */
386 if (!(Flags
) && !(Eip
& 0x80000000)) break;
388 /* Save this frame */
389 Callers
[i
] = (PVOID
)Eip
;
391 /* Check if we should continue */
394 /* Return the next index */
399 /* Move to the next stack */
403 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
410 /* Return frames parsed */
416 /* RTL Atom Tables ************************************************************/
419 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
421 ExInitializeFastMutex(&AtomTable
->FastMutex
);
423 return STATUS_SUCCESS
;
428 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
434 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
436 ExAcquireFastMutex(&AtomTable
->FastMutex
);
441 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
443 ExReleaseFastMutex(&AtomTable
->FastMutex
);
447 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
449 AtomTable
->ExHandleTable
= ExCreateHandleTable(NULL
);
450 return (AtomTable
->ExHandleTable
!= NULL
);
454 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
456 if (AtomTable
->ExHandleTable
)
458 ExSweepHandleTable(AtomTable
->ExHandleTable
,
461 ExDestroyHandleTable(AtomTable
->ExHandleTable
, NULL
);
462 AtomTable
->ExHandleTable
= NULL
;
467 RtlpAllocAtomTable(ULONG Size
)
469 PRTL_ATOM_TABLE Table
= ExAllocatePool(NonPagedPool
,
481 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
483 ExFreePool(AtomTable
);
486 PRTL_ATOM_TABLE_ENTRY
487 RtlpAllocAtomTableEntry(ULONG Size
)
489 PRTL_ATOM_TABLE_ENTRY Entry
;
491 Entry
= ExAllocatePoolWithTag(NonPagedPool
, Size
, TAG_ATMT
);
494 RtlZeroMemory(Entry
, Size
);
501 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
503 ExFreePoolWithTag(Entry
, TAG_ATMT
);
507 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
509 ExDestroyHandle(AtomTable
->ExHandleTable
,
510 (HANDLE
)((ULONG_PTR
)Entry
->HandleIndex
<< 2),
515 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
517 HANDLE_TABLE_ENTRY ExEntry
;
521 /* Initialize ex handle table entry */
522 ExEntry
.Object
= Entry
;
523 ExEntry
.GrantedAccess
= 0x1; /* FIXME - valid handle */
525 /* Create ex handle */
526 Handle
= ExCreateHandle(AtomTable
->ExHandleTable
,
528 if (!Handle
) return FALSE
;
530 /* Calculate HandleIndex (by getting rid of the first two bits) */
531 HandleIndex
= (USHORT
)((ULONG_PTR
)Handle
>> 2);
533 /* Index must be less than 0xC000 */
534 if (HandleIndex
>= 0xC000)
536 /* Destroy ex handle */
537 ExDestroyHandle(AtomTable
->ExHandleTable
,
545 /* Initialize atom table entry */
546 Entry
->HandleIndex
= HandleIndex
;
547 Entry
->Atom
= 0xC000 + HandleIndex
;
553 PRTL_ATOM_TABLE_ENTRY
554 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
556 PHANDLE_TABLE_ENTRY ExEntry
;
557 PRTL_ATOM_TABLE_ENTRY Entry
= NULL
;
559 /* NOTE: There's no need to explicitly enter a critical region because it's
560 guaranteed that we're in a critical region right now (as we hold
561 the atom table lock) */
563 ExEntry
= ExMapHandleToPointer(AtomTable
->ExHandleTable
,
564 (HANDLE
)((ULONG_PTR
)Index
<< 2));
567 Entry
= ExEntry
->Object
;
569 ExUnlockHandleTableEntry(AtomTable
->ExHandleTable
,
577 * Ldr Resource support code
580 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
581 LPCWSTR name
, void *root
,
583 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
584 USHORT id
, void *root
, int want_dir
);
585 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
586 void *root
, int want_dir
);
588 /**********************************************************************
591 * Find a resource entry
593 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
594 ULONG level
, void **ret
, int want_dir
)
598 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
600 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
601 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
604 if (!level
--) goto done
;
605 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
606 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
607 if (!level
--) return STATUS_SUCCESS
;
610 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
611 return STATUS_RESOURCE_NAME_NOT_FOUND
;
612 if (!level
--) return STATUS_SUCCESS
;
613 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
617 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
619 return STATUS_RESOURCE_DATA_NOT_FOUND
;
623 return STATUS_SUCCESS
;