2 * COPYRIGHT: See COPYING in the top level directory
3 * PROJECT: ReactOS NT User-Mode DLL
4 * FILE: lib/ntdll/rtl/libsup.c
5 * PURPOSE: RTL Support Routines
6 * PROGRAMMERS: Alex Ionescu (alex@relsoft.net)
10 /* INCLUDES *****************************************************************/
17 SIZE_T RtlpAllocDeallocQueryBufferSize
= PAGE_SIZE
;
18 PTEB LdrpTopLevelDllBeingLoadedTeb
= NULL
;
20 /* FUNCTIONS ***************************************************************/
23 // FIXME: Why "Not implemented"???
29 RtlWalkFrameChain(OUT PVOID
*Callers
,
33 /* Not implemented for user-mode */
40 RtlpCheckForActiveDebugger(VOID
)
42 /* Return the flag in the PEB */
43 return NtCurrentPeb()->BeingDebugged
;
48 RtlpSetInDbgPrint(VOID
)
50 /* Check if it's already set and return TRUE if so */
51 if (NtCurrentTeb()->InDbgPrint
) return TRUE
;
53 /* Set it and return */
54 NtCurrentTeb()->InDbgPrint
= TRUE
;
60 RtlpClearInDbgPrint(VOID
)
63 NtCurrentTeb()->InDbgPrint
= FALSE
;
78 RtlGetCurrentPeb(VOID
)
80 return NtCurrentPeb();
87 RtlAcquirePebLock(VOID
)
89 PPEB Peb
= NtCurrentPeb ();
90 RtlEnterCriticalSection(Peb
->FastPebLock
);
97 RtlReleasePebLock(VOID
)
99 PPEB Peb
= NtCurrentPeb ();
100 RtlLeaveCriticalSection(Peb
->FastPebLock
);
108 RtlGetNtGlobalFlags(VOID
)
110 PPEB pPeb
= NtCurrentPeb();
111 return pPeb
->NtGlobalFlag
;
116 RtlDeleteHeapLock(IN OUT PHEAP_LOCK Lock
)
118 return RtlDeleteCriticalSection(&Lock
->CriticalSection
);
123 RtlEnterHeapLock(IN OUT PHEAP_LOCK Lock
, IN BOOLEAN Exclusive
)
125 UNREFERENCED_PARAMETER(Exclusive
);
127 return RtlEnterCriticalSection(&Lock
->CriticalSection
);
132 RtlTryEnterHeapLock(IN OUT PHEAP_LOCK Lock
, IN BOOLEAN Exclusive
)
134 UNREFERENCED_PARAMETER(Exclusive
);
136 return RtlTryEnterCriticalSection(&Lock
->CriticalSection
);
141 RtlInitializeHeapLock(IN OUT PHEAP_LOCK
*Lock
)
143 return RtlInitializeCriticalSection(&(*Lock
)->CriticalSection
);
148 RtlLeaveHeapLock(IN OUT PHEAP_LOCK Lock
)
150 return RtlLeaveCriticalSection(&Lock
->CriticalSection
);
155 RtlpAllocateMemory(UINT Bytes
,
158 UNREFERENCED_PARAMETER(Tag
);
160 return RtlAllocateHeap(RtlGetProcessHeap(),
168 RtlpFreeMemory(PVOID Mem
,
171 UNREFERENCED_PARAMETER(Tag
);
173 RtlFreeHeap(RtlGetProcessHeap(),
181 CHECK_PAGED_CODE_RTL(char *file
, int line
)
183 /* meaningless in user mode */
189 RtlpSetHeapParameters(IN PRTL_HEAP_PARAMETERS Parameters
)
194 Peb
= RtlGetCurrentPeb();
196 /* Apply defaults for non-set parameters */
197 if (!Parameters
->SegmentCommit
) Parameters
->SegmentCommit
= Peb
->HeapSegmentCommit
;
198 if (!Parameters
->SegmentReserve
) Parameters
->SegmentReserve
= Peb
->HeapSegmentReserve
;
199 if (!Parameters
->DeCommitFreeBlockThreshold
) Parameters
->DeCommitFreeBlockThreshold
= Peb
->HeapDeCommitFreeBlockThreshold
;
200 if (!Parameters
->DeCommitTotalFreeThreshold
) Parameters
->DeCommitTotalFreeThreshold
= Peb
->HeapDeCommitTotalFreeThreshold
;
205 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
206 IN ULONG_PTR RegistrationFrameEnd
,
207 IN OUT PULONG_PTR StackLow
,
208 IN OUT PULONG_PTR StackHigh
)
210 /* There's no such thing as a DPC stack in user-mode */
216 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
217 IN PCONTEXT ContextRecord
,
218 IN PVOID ContextData
,
221 /* Exception logging is not done in user-mode */
226 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
227 IN ULONG_PTR
*StackBegin
,
228 IN ULONG_PTR
*StackEnd
)
231 *StackBegin
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
232 *StackEnd
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
240 OUT PULONG_PTR LowLimit
,
241 OUT PULONG_PTR HighLimit
)
243 *LowLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
244 *HighLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
251 RtlIsThreadWithinLoaderCallout(VOID
)
253 return LdrpTopLevelDllBeingLoadedTeb
== NtCurrentTeb();
256 /* RTL Atom Tables ************************************************************/
258 typedef struct _RTL_ATOM_HANDLE
260 RTL_HANDLE_TABLE_ENTRY Handle
;
261 PRTL_ATOM_TABLE_ENTRY AtomEntry
;
262 } RTL_ATOM_HANDLE
, *PRTL_ATOM_HANDLE
;
265 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
267 RtlInitializeCriticalSection(&AtomTable
->CriticalSection
);
268 return STATUS_SUCCESS
;
273 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
275 RtlDeleteCriticalSection(&AtomTable
->CriticalSection
);
280 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
282 RtlEnterCriticalSection(&AtomTable
->CriticalSection
);
288 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
290 RtlLeaveCriticalSection(&AtomTable
->CriticalSection
);
294 /* handle functions */
297 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
299 RtlInitializeHandleTable(0xCFFF,
300 sizeof(RTL_ATOM_HANDLE
),
301 &AtomTable
->RtlHandleTable
);
307 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
309 RtlDestroyHandleTable(&AtomTable
->RtlHandleTable
);
313 RtlpAllocAtomTable(ULONG Size
)
315 return (PRTL_ATOM_TABLE
)RtlAllocateHeap(RtlGetProcessHeap(),
321 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
323 RtlFreeHeap(RtlGetProcessHeap(),
328 PRTL_ATOM_TABLE_ENTRY
329 RtlpAllocAtomTableEntry(ULONG Size
)
331 return (PRTL_ATOM_TABLE_ENTRY
)RtlAllocateHeap(RtlGetProcessHeap(),
337 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
339 RtlFreeHeap(RtlGetProcessHeap(),
345 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
347 PRTL_HANDLE_TABLE_ENTRY RtlHandleEntry
;
349 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
350 (ULONG
)Entry
->HandleIndex
,
353 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
359 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
362 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
364 RtlHandle
= RtlAllocateHandle(&AtomTable
->RtlHandleTable
,
366 if (RtlHandle
!= NULL
)
368 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
370 /* FIXME - Handle Indexes >= 0xC000 ?! */
371 if (HandleIndex
< 0xC000)
373 Entry
->HandleIndex
= (USHORT
)HandleIndex
;
374 Entry
->Atom
= 0xC000 + (USHORT
)HandleIndex
;
376 AtomHandle
->AtomEntry
= Entry
;
377 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
383 /* set the valid flag, otherwise RtlFreeHandle will fail! */
384 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
386 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
394 PRTL_ATOM_TABLE_ENTRY
395 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
397 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
399 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
403 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
405 return AtomHandle
->AtomEntry
;
413 * Ldr Resource support code
416 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
417 LPCWSTR name
, void *root
,
419 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
420 WORD id
, void *root
, int want_dir
);
421 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
422 void *root
, int want_dir
);
423 int push_language( USHORT
*list
, ULONG pos
, WORD lang
);
425 /**********************************************************************
428 * Find a resource entry
430 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
431 ULONG level
, void **ret
, int want_dir
)
435 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
436 USHORT list
[9]; /* list of languages to try */
438 LCID user_lcid
, system_lcid
;
440 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
441 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
442 if (size
< sizeof(*resdirptr
)) return STATUS_RESOURCE_DATA_NOT_FOUND
;
445 if (!level
--) goto done
;
446 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
447 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
448 if (!level
--) return STATUS_SUCCESS
;
451 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
452 return STATUS_RESOURCE_NAME_NOT_FOUND
;
453 if (!level
--) return STATUS_SUCCESS
;
454 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
456 /* 1. specified language */
457 pos
= push_language( list
, pos
, info
->Language
);
459 /* 2. specified language with neutral sublanguage */
460 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(info
->Language
), SUBLANG_NEUTRAL
) );
462 /* 3. neutral language with neutral sublanguage */
463 pos
= push_language( list
, pos
, MAKELANGID( LANG_NEUTRAL
, SUBLANG_NEUTRAL
) );
465 /* if no explicitly specified language, try some defaults */
466 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
468 /* user defaults, unless SYS_DEFAULT sublanguage specified */
469 if (SUBLANGID(info
->Language
) != SUBLANG_SYS_DEFAULT
)
471 /* 4. current thread locale language */
472 pos
= push_language( list
, pos
, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale
) );
474 if (NT_SUCCESS(NtQueryDefaultLocale(TRUE
, &user_lcid
)))
476 /* 5. user locale language */
477 pos
= push_language( list
, pos
, LANGIDFROMLCID(user_lcid
) );
479 /* 6. user locale language with neutral sublanguage */
480 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(user_lcid
), SUBLANG_NEUTRAL
) );
484 /* now system defaults */
486 if (NT_SUCCESS(NtQueryDefaultLocale(FALSE
, &system_lcid
)))
488 /* 7. system locale language */
489 pos
= push_language( list
, pos
, LANGIDFROMLCID( system_lcid
) );
491 /* 8. system locale language with neutral sublanguage */
492 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(system_lcid
), SUBLANG_NEUTRAL
) );
496 pos
= push_language( list
, pos
, MAKELANGID( LANG_ENGLISH
, SUBLANG_DEFAULT
) );
500 for (i
= 0; i
< pos
; i
++)
501 if ((*ret
= find_entry_by_id( resdirptr
, list
[i
], root
, want_dir
))) return STATUS_SUCCESS
;
503 /* if no explicitly specified language, return the first entry */
504 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
506 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
508 return STATUS_RESOURCE_LANG_NOT_FOUND
;
512 return STATUS_SUCCESS
;
519 RtlPcToFileHeader(IN PVOID PcValue
,
522 PLIST_ENTRY ModuleListHead
;
524 PLDR_DATA_TABLE_ENTRY Module
;
525 PVOID ImageBase
= NULL
;
527 RtlEnterCriticalSection (NtCurrentPeb()->LoaderLock
);
528 ModuleListHead
= &NtCurrentPeb()->Ldr
->InLoadOrderModuleList
;
529 Entry
= ModuleListHead
->Flink
;
530 while (Entry
!= ModuleListHead
)
532 Module
= CONTAINING_RECORD(Entry
, LDR_DATA_TABLE_ENTRY
, InLoadOrderLinks
);
534 if ((ULONG_PTR
)PcValue
>= (ULONG_PTR
)Module
->DllBase
&&
535 (ULONG_PTR
)PcValue
< (ULONG_PTR
)Module
->DllBase
+ Module
->SizeOfImage
)
537 ImageBase
= Module
->DllBase
;
540 Entry
= Entry
->Flink
;
542 RtlLeaveCriticalSection (NtCurrentPeb()->LoaderLock
);
544 *BaseOfImage
= ImageBase
;
554 RtlDosApplyFileIsolationRedirection_Ustr(IN ULONG Flags
,
555 IN PUNICODE_STRING OriginalName
,
556 IN PUNICODE_STRING Extension
,
557 IN OUT PUNICODE_STRING StaticString
,
558 IN OUT PUNICODE_STRING DynamicString
,
559 IN OUT PUNICODE_STRING
*NewName
,
561 IN PSIZE_T FileNameSize
,
562 IN PSIZE_T RequiredLength
)
564 return STATUS_SXS_KEY_NOT_FOUND
;
573 RtlWow64EnableFsRedirection(IN BOOLEAN Wow64FsEnableRedirection
)
575 /* This is what Windows returns on x86 */
576 return STATUS_NOT_IMPLEMENTED
;
585 RtlWow64EnableFsRedirectionEx(IN PVOID Wow64FsEnableRedirection
,
586 OUT PVOID
*OldFsRedirectionLevel
)
588 /* This is what Windows returns on x86 */
589 return STATUS_NOT_IMPLEMENTED
;
598 RtlComputeImportTableHash(IN HANDLE FileHandle
,
600 IN ULONG ImporTTableHashSize
)
603 return STATUS_NOT_IMPLEMENTED
;
609 _Out_writes_bytes_all_(Length
) VOID UNALIGNED
*Destination
,
610 _In_reads_bytes_(Length
) CONST VOID UNALIGNED
*Source
,
615 RtlCopyMemory(Destination
, Source
, Length
);
617 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
619 _SEH2_YIELD(return _SEH2_GetExceptionCode());
623 return STATUS_SUCCESS
;
626 /* FIXME: code duplication with kernel32/client/time.c */
629 RtlGetTickCount(VOID
)
631 ULARGE_INTEGER TickCount
;
634 TickCount
.QuadPart
= *((volatile ULONG64
*)&SharedUserData
->TickCount
);
638 TickCount
.HighPart
= (ULONG
)SharedUserData
->TickCount
.High1Time
;
639 TickCount
.LowPart
= SharedUserData
->TickCount
.LowPart
;
641 if (TickCount
.HighPart
== (ULONG
)SharedUserData
->TickCount
.High2Time
)
648 return (ULONG
)((UInt32x32To64(TickCount
.LowPart
,
649 SharedUserData
->TickCountMultiplier
) >> 24) +
650 UInt32x32To64((TickCount
.HighPart
<< 8) & 0xFFFFFFFF,
651 SharedUserData
->TickCountMultiplier
));