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 RtlInitializeHeapLock(IN OUT PHEAP_LOCK
*Lock
)
134 return RtlInitializeCriticalSection(&(*Lock
)->CriticalSection
);
139 RtlLeaveHeapLock(IN OUT PHEAP_LOCK Lock
)
141 return RtlLeaveCriticalSection(&Lock
->CriticalSection
);
146 RtlpAllocateMemory(UINT Bytes
,
149 UNREFERENCED_PARAMETER(Tag
);
151 return RtlAllocateHeap(RtlGetProcessHeap(),
159 RtlpFreeMemory(PVOID Mem
,
162 UNREFERENCED_PARAMETER(Tag
);
164 RtlFreeHeap(RtlGetProcessHeap(),
172 CHECK_PAGED_CODE_RTL(char *file
, int line
)
174 /* meaningless in user mode */
180 RtlpSetHeapParameters(IN PRTL_HEAP_PARAMETERS Parameters
)
185 Peb
= RtlGetCurrentPeb();
187 /* Apply defaults for non-set parameters */
188 if (!Parameters
->SegmentCommit
) Parameters
->SegmentCommit
= Peb
->HeapSegmentCommit
;
189 if (!Parameters
->SegmentReserve
) Parameters
->SegmentReserve
= Peb
->HeapSegmentReserve
;
190 if (!Parameters
->DeCommitFreeBlockThreshold
) Parameters
->DeCommitFreeBlockThreshold
= Peb
->HeapDeCommitFreeBlockThreshold
;
191 if (!Parameters
->DeCommitTotalFreeThreshold
) Parameters
->DeCommitTotalFreeThreshold
= Peb
->HeapDeCommitTotalFreeThreshold
;
196 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
197 IN ULONG_PTR RegistrationFrameEnd
,
198 IN OUT PULONG_PTR StackLow
,
199 IN OUT PULONG_PTR StackHigh
)
201 /* There's no such thing as a DPC stack in user-mode */
207 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
208 IN PCONTEXT ContextRecord
,
209 IN PVOID ContextData
,
212 /* Exception logging is not done in user-mode */
217 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
218 IN ULONG_PTR
*StackBegin
,
219 IN ULONG_PTR
*StackEnd
)
222 *StackBegin
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
223 *StackEnd
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
231 OUT PULONG_PTR LowLimit
,
232 OUT PULONG_PTR HighLimit
)
234 *LowLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
235 *HighLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
242 RtlIsThreadWithinLoaderCallout(VOID
)
244 return LdrpTopLevelDllBeingLoadedTeb
== NtCurrentTeb();
247 /* RTL Atom Tables ************************************************************/
249 typedef struct _RTL_ATOM_HANDLE
251 RTL_HANDLE_TABLE_ENTRY Handle
;
252 PRTL_ATOM_TABLE_ENTRY AtomEntry
;
253 } RTL_ATOM_HANDLE
, *PRTL_ATOM_HANDLE
;
256 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
258 RtlInitializeCriticalSection(&AtomTable
->CriticalSection
);
259 return STATUS_SUCCESS
;
264 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
266 RtlDeleteCriticalSection(&AtomTable
->CriticalSection
);
271 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
273 RtlEnterCriticalSection(&AtomTable
->CriticalSection
);
279 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
281 RtlLeaveCriticalSection(&AtomTable
->CriticalSection
);
285 /* handle functions */
288 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
290 RtlInitializeHandleTable(0xCFFF,
291 sizeof(RTL_ATOM_HANDLE
),
292 &AtomTable
->RtlHandleTable
);
298 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
300 RtlDestroyHandleTable(&AtomTable
->RtlHandleTable
);
304 RtlpAllocAtomTable(ULONG Size
)
306 return (PRTL_ATOM_TABLE
)RtlAllocateHeap(RtlGetProcessHeap(),
312 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
314 RtlFreeHeap(RtlGetProcessHeap(),
319 PRTL_ATOM_TABLE_ENTRY
320 RtlpAllocAtomTableEntry(ULONG Size
)
322 return (PRTL_ATOM_TABLE_ENTRY
)RtlAllocateHeap(RtlGetProcessHeap(),
328 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
330 RtlFreeHeap(RtlGetProcessHeap(),
336 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
338 PRTL_HANDLE_TABLE_ENTRY RtlHandleEntry
;
340 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
341 (ULONG
)Entry
->HandleIndex
,
344 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
350 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
353 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
355 RtlHandle
= RtlAllocateHandle(&AtomTable
->RtlHandleTable
,
357 if (RtlHandle
!= NULL
)
359 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
361 /* FIXME - Handle Indexes >= 0xC000 ?! */
362 if (HandleIndex
< 0xC000)
364 Entry
->HandleIndex
= (USHORT
)HandleIndex
;
365 Entry
->Atom
= 0xC000 + (USHORT
)HandleIndex
;
367 AtomHandle
->AtomEntry
= Entry
;
368 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
374 /* set the valid flag, otherwise RtlFreeHandle will fail! */
375 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
377 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
385 PRTL_ATOM_TABLE_ENTRY
386 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
388 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
390 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
394 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
396 return AtomHandle
->AtomEntry
;
404 * Ldr Resource support code
407 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
408 LPCWSTR name
, void *root
,
410 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
411 WORD id
, void *root
, int want_dir
);
412 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
413 void *root
, int want_dir
);
414 int push_language( USHORT
*list
, ULONG pos
, WORD lang
);
416 /**********************************************************************
419 * Find a resource entry
421 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
422 ULONG level
, void **ret
, int want_dir
)
426 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
427 USHORT list
[9]; /* list of languages to try */
429 LCID user_lcid
, system_lcid
;
431 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
432 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
435 if (!level
--) goto done
;
436 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
437 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
438 if (!level
--) return STATUS_SUCCESS
;
441 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
442 return STATUS_RESOURCE_NAME_NOT_FOUND
;
443 if (!level
--) return STATUS_SUCCESS
;
444 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
446 /* 1. specified language */
447 pos
= push_language( list
, pos
, info
->Language
);
449 /* 2. specified language with neutral sublanguage */
450 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(info
->Language
), SUBLANG_NEUTRAL
) );
452 /* 3. neutral language with neutral sublanguage */
453 pos
= push_language( list
, pos
, MAKELANGID( LANG_NEUTRAL
, SUBLANG_NEUTRAL
) );
455 /* if no explicitly specified language, try some defaults */
456 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
458 /* user defaults, unless SYS_DEFAULT sublanguage specified */
459 if (SUBLANGID(info
->Language
) != SUBLANG_SYS_DEFAULT
)
461 /* 4. current thread locale language */
462 pos
= push_language( list
, pos
, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale
) );
464 if (NT_SUCCESS(NtQueryDefaultLocale(TRUE
, &user_lcid
)))
466 /* 5. user locale language */
467 pos
= push_language( list
, pos
, LANGIDFROMLCID(user_lcid
) );
469 /* 6. user locale language with neutral sublanguage */
470 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(user_lcid
), SUBLANG_NEUTRAL
) );
474 /* now system defaults */
476 if (NT_SUCCESS(NtQueryDefaultLocale(FALSE
, &system_lcid
)))
478 /* 7. system locale language */
479 pos
= push_language( list
, pos
, LANGIDFROMLCID( system_lcid
) );
481 /* 8. system locale language with neutral sublanguage */
482 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(system_lcid
), SUBLANG_NEUTRAL
) );
486 pos
= push_language( list
, pos
, MAKELANGID( LANG_ENGLISH
, SUBLANG_DEFAULT
) );
490 for (i
= 0; i
< pos
; i
++)
491 if ((*ret
= find_entry_by_id( resdirptr
, list
[i
], root
, want_dir
))) return STATUS_SUCCESS
;
493 /* if no explicitly specified language, return the first entry */
494 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
496 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
498 return STATUS_RESOURCE_LANG_NOT_FOUND
;
502 return STATUS_SUCCESS
;
509 RtlPcToFileHeader(IN PVOID PcValue
,
512 PLIST_ENTRY ModuleListHead
;
514 PLDR_DATA_TABLE_ENTRY Module
;
515 PVOID ImageBase
= NULL
;
517 RtlEnterCriticalSection (NtCurrentPeb()->LoaderLock
);
518 ModuleListHead
= &NtCurrentPeb()->Ldr
->InLoadOrderModuleList
;
519 Entry
= ModuleListHead
->Flink
;
520 while (Entry
!= ModuleListHead
)
522 Module
= CONTAINING_RECORD(Entry
, LDR_DATA_TABLE_ENTRY
, InLoadOrderLinks
);
524 if ((ULONG_PTR
)PcValue
>= (ULONG_PTR
)Module
->DllBase
&&
525 (ULONG_PTR
)PcValue
< (ULONG_PTR
)Module
->DllBase
+ Module
->SizeOfImage
)
527 ImageBase
= Module
->DllBase
;
530 Entry
= Entry
->Flink
;
532 RtlLeaveCriticalSection (NtCurrentPeb()->LoaderLock
);
534 *BaseOfImage
= ImageBase
;
544 RtlDosApplyFileIsolationRedirection_Ustr(IN ULONG Flags
,
545 IN PUNICODE_STRING OriginalName
,
546 IN PUNICODE_STRING Extension
,
547 IN OUT PUNICODE_STRING StaticString
,
548 IN OUT PUNICODE_STRING DynamicString
,
549 IN OUT PUNICODE_STRING
*NewName
,
551 IN PSIZE_T FileNameSize
,
552 IN PSIZE_T RequiredLength
)
554 return STATUS_SXS_KEY_NOT_FOUND
;
563 RtlWow64EnableFsRedirection(IN BOOLEAN Wow64FsEnableRedirection
)
565 /* This is what Windows returns on x86 */
566 return STATUS_NOT_IMPLEMENTED
;
575 RtlWow64EnableFsRedirectionEx(IN PVOID Wow64FsEnableRedirection
,
576 OUT PVOID
*OldFsRedirectionLevel
)
578 /* This is what Windows returns on x86 */
579 return STATUS_NOT_IMPLEMENTED
;
588 RtlComputeImportTableHash(IN HANDLE FileHandle
,
590 IN ULONG ImporTTableHashSize
)
593 return STATUS_NOT_IMPLEMENTED
;
599 _Out_writes_bytes_all_(Length
) VOID UNALIGNED
*Destination
,
600 _In_reads_bytes_(Length
) CONST VOID UNALIGNED
*Source
,
605 RtlCopyMemory(Destination
, Source
, Length
);
607 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
609 _SEH2_YIELD(return _SEH2_GetExceptionCode());
613 return STATUS_SUCCESS
;
616 /* FIXME: code duplication with kernel32/client/time.c */
619 RtlGetTickCount(VOID
)
621 ULARGE_INTEGER TickCount
;
624 TickCount
.QuadPart
= *((volatile ULONG64
*)&SharedUserData
->TickCount
);
628 TickCount
.HighPart
= (ULONG
)SharedUserData
->TickCount
.High1Time
;
629 TickCount
.LowPart
= SharedUserData
->TickCount
.LowPart
;
631 if (TickCount
.HighPart
== (ULONG
)SharedUserData
->TickCount
.High2Time
)
638 return (ULONG
)((UInt32x32To64(TickCount
.LowPart
,
639 SharedUserData
->TickCountMultiplier
) >> 24) +
640 UInt32x32To64((TickCount
.HighPart
<< 8) & 0xFFFFFFFF,
641 SharedUserData
->TickCountMultiplier
));