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 *****************************************************************/
16 SIZE_T RtlpAllocDeallocQueryBufferSize
= PAGE_SIZE
;
17 PTEB LdrpTopLevelDllBeingLoadedTeb
= NULL
;
19 /* FUNCTIONS ***************************************************************/
22 // FIXME: Why "Not implemented"???
28 RtlWalkFrameChain(OUT PVOID
*Callers
,
32 /* Not implemented for user-mode */
39 RtlpCheckForActiveDebugger(VOID
)
41 /* Return the flag in the PEB */
42 return NtCurrentPeb()->BeingDebugged
;
47 RtlpSetInDbgPrint(VOID
)
49 /* Check if it's already set and return TRUE if so */
50 if (NtCurrentTeb()->InDbgPrint
) return TRUE
;
52 /* Set it and return */
53 NtCurrentTeb()->InDbgPrint
= TRUE
;
59 RtlpClearInDbgPrint(VOID
)
62 NtCurrentTeb()->InDbgPrint
= FALSE
;
77 RtlGetCurrentPeb(VOID
)
79 return NtCurrentPeb();
86 RtlAcquirePebLock(VOID
)
88 PPEB Peb
= NtCurrentPeb ();
89 RtlEnterCriticalSection(Peb
->FastPebLock
);
96 RtlReleasePebLock(VOID
)
98 PPEB Peb
= NtCurrentPeb ();
99 RtlLeaveCriticalSection(Peb
->FastPebLock
);
107 RtlGetNtGlobalFlags(VOID
)
109 PPEB pPeb
= NtCurrentPeb();
110 return pPeb
->NtGlobalFlag
;
115 RtlDeleteHeapLock(IN OUT PHEAP_LOCK Lock
)
117 return RtlDeleteCriticalSection(&Lock
->CriticalSection
);
122 RtlEnterHeapLock(IN OUT PHEAP_LOCK Lock
, IN BOOLEAN Exclusive
)
124 UNREFERENCED_PARAMETER(Exclusive
);
126 return RtlEnterCriticalSection(&Lock
->CriticalSection
);
131 RtlInitializeHeapLock(IN OUT PHEAP_LOCK
*Lock
)
133 return RtlInitializeCriticalSection(&(*Lock
)->CriticalSection
);
138 RtlLeaveHeapLock(IN OUT PHEAP_LOCK Lock
)
140 return RtlLeaveCriticalSection(&Lock
->CriticalSection
);
145 RtlpAllocateMemory(UINT Bytes
,
148 UNREFERENCED_PARAMETER(Tag
);
150 return RtlAllocateHeap(RtlGetProcessHeap(),
158 RtlpFreeMemory(PVOID Mem
,
161 UNREFERENCED_PARAMETER(Tag
);
163 RtlFreeHeap(RtlGetProcessHeap(),
171 CHECK_PAGED_CODE_RTL(char *file
, int line
)
173 /* meaningless in user mode */
179 RtlpSetHeapParameters(IN PRTL_HEAP_PARAMETERS Parameters
)
184 Peb
= RtlGetCurrentPeb();
186 /* Apply defaults for non-set parameters */
187 if (!Parameters
->SegmentCommit
) Parameters
->SegmentCommit
= Peb
->HeapSegmentCommit
;
188 if (!Parameters
->SegmentReserve
) Parameters
->SegmentReserve
= Peb
->HeapSegmentReserve
;
189 if (!Parameters
->DeCommitFreeBlockThreshold
) Parameters
->DeCommitFreeBlockThreshold
= Peb
->HeapDeCommitFreeBlockThreshold
;
190 if (!Parameters
->DeCommitTotalFreeThreshold
) Parameters
->DeCommitTotalFreeThreshold
= Peb
->HeapDeCommitTotalFreeThreshold
;
195 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
196 IN ULONG_PTR RegistrationFrameEnd
,
197 IN OUT PULONG_PTR StackLow
,
198 IN OUT PULONG_PTR StackHigh
)
200 /* There's no such thing as a DPC stack in user-mode */
206 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
207 IN PCONTEXT ContextRecord
,
208 IN PVOID ContextData
,
211 /* Exception logging is not done in user-mode */
216 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
217 IN ULONG_PTR
*StackBegin
,
218 IN ULONG_PTR
*StackEnd
)
221 *StackBegin
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
222 *StackEnd
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
230 OUT PULONG_PTR LowLimit
,
231 OUT PULONG_PTR HighLimit
)
233 *LowLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackLimit
;
234 *HighLimit
= (ULONG_PTR
)NtCurrentTeb()->NtTib
.StackBase
;
241 RtlIsThreadWithinLoaderCallout(VOID
)
243 return LdrpTopLevelDllBeingLoadedTeb
== NtCurrentTeb();
246 /* RTL Atom Tables ************************************************************/
248 typedef struct _RTL_ATOM_HANDLE
250 RTL_HANDLE_TABLE_ENTRY Handle
;
251 PRTL_ATOM_TABLE_ENTRY AtomEntry
;
252 } RTL_ATOM_HANDLE
, *PRTL_ATOM_HANDLE
;
255 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
257 RtlInitializeCriticalSection(&AtomTable
->CriticalSection
);
258 return STATUS_SUCCESS
;
263 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
265 RtlDeleteCriticalSection(&AtomTable
->CriticalSection
);
270 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
272 RtlEnterCriticalSection(&AtomTable
->CriticalSection
);
278 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
280 RtlLeaveCriticalSection(&AtomTable
->CriticalSection
);
284 /* handle functions */
287 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
289 RtlInitializeHandleTable(0xCFFF,
290 sizeof(RTL_ATOM_HANDLE
),
291 &AtomTable
->RtlHandleTable
);
297 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
299 RtlDestroyHandleTable(&AtomTable
->RtlHandleTable
);
303 RtlpAllocAtomTable(ULONG Size
)
305 return (PRTL_ATOM_TABLE
)RtlAllocateHeap(RtlGetProcessHeap(),
311 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
313 RtlFreeHeap(RtlGetProcessHeap(),
318 PRTL_ATOM_TABLE_ENTRY
319 RtlpAllocAtomTableEntry(ULONG Size
)
321 return (PRTL_ATOM_TABLE_ENTRY
)RtlAllocateHeap(RtlGetProcessHeap(),
327 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
329 RtlFreeHeap(RtlGetProcessHeap(),
335 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
337 PRTL_HANDLE_TABLE_ENTRY RtlHandleEntry
;
339 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
340 (ULONG
)Entry
->HandleIndex
,
343 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
349 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
352 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
354 RtlHandle
= RtlAllocateHandle(&AtomTable
->RtlHandleTable
,
356 if (RtlHandle
!= NULL
)
358 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
360 /* FIXME - Handle Indexes >= 0xC000 ?! */
361 if (HandleIndex
< 0xC000)
363 Entry
->HandleIndex
= (USHORT
)HandleIndex
;
364 Entry
->Atom
= 0xC000 + (USHORT
)HandleIndex
;
366 AtomHandle
->AtomEntry
= Entry
;
367 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
373 /* set the valid flag, otherwise RtlFreeHandle will fail! */
374 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
376 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
384 PRTL_ATOM_TABLE_ENTRY
385 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
387 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
389 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
393 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
395 return AtomHandle
->AtomEntry
;
403 * Ldr Resource support code
406 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
407 LPCWSTR name
, void *root
,
409 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
410 WORD id
, void *root
, int want_dir
);
411 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
412 void *root
, int want_dir
);
413 int push_language( USHORT
*list
, ULONG pos
, WORD lang
);
415 /**********************************************************************
418 * Find a resource entry
420 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
421 ULONG level
, void **ret
, int want_dir
)
425 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
426 USHORT list
[9]; /* list of languages to try */
428 LCID user_lcid
, system_lcid
;
430 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
431 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
434 if (!level
--) goto done
;
435 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
436 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
437 if (!level
--) return STATUS_SUCCESS
;
440 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
441 return STATUS_RESOURCE_NAME_NOT_FOUND
;
442 if (!level
--) return STATUS_SUCCESS
;
443 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
445 /* 1. specified language */
446 pos
= push_language( list
, pos
, info
->Language
);
448 /* 2. specified language with neutral sublanguage */
449 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(info
->Language
), SUBLANG_NEUTRAL
) );
451 /* 3. neutral language with neutral sublanguage */
452 pos
= push_language( list
, pos
, MAKELANGID( LANG_NEUTRAL
, SUBLANG_NEUTRAL
) );
454 /* if no explicitly specified language, try some defaults */
455 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
457 /* user defaults, unless SYS_DEFAULT sublanguage specified */
458 if (SUBLANGID(info
->Language
) != SUBLANG_SYS_DEFAULT
)
460 /* 4. current thread locale language */
461 pos
= push_language( list
, pos
, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale
) );
463 if (NT_SUCCESS(NtQueryDefaultLocale(TRUE
, &user_lcid
)))
465 /* 5. user locale language */
466 pos
= push_language( list
, pos
, LANGIDFROMLCID(user_lcid
) );
468 /* 6. user locale language with neutral sublanguage */
469 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(user_lcid
), SUBLANG_NEUTRAL
) );
473 /* now system defaults */
475 if (NT_SUCCESS(NtQueryDefaultLocale(FALSE
, &system_lcid
)))
477 /* 7. system locale language */
478 pos
= push_language( list
, pos
, LANGIDFROMLCID( system_lcid
) );
480 /* 8. system locale language with neutral sublanguage */
481 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(system_lcid
), SUBLANG_NEUTRAL
) );
485 pos
= push_language( list
, pos
, MAKELANGID( LANG_ENGLISH
, SUBLANG_DEFAULT
) );
489 for (i
= 0; i
< pos
; i
++)
490 if ((*ret
= find_entry_by_id( resdirptr
, list
[i
], root
, want_dir
))) return STATUS_SUCCESS
;
492 /* if no explicitly specified language, return the first entry */
493 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
495 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
497 return STATUS_RESOURCE_LANG_NOT_FOUND
;
501 return STATUS_SUCCESS
;
508 RtlPcToFileHeader(IN PVOID PcValue
,
511 PLIST_ENTRY ModuleListHead
;
513 PLDR_DATA_TABLE_ENTRY Module
;
514 PVOID ImageBase
= NULL
;
516 RtlEnterCriticalSection (NtCurrentPeb()->LoaderLock
);
517 ModuleListHead
= &NtCurrentPeb()->Ldr
->InLoadOrderModuleList
;
518 Entry
= ModuleListHead
->Flink
;
519 while (Entry
!= ModuleListHead
)
521 Module
= CONTAINING_RECORD(Entry
, LDR_DATA_TABLE_ENTRY
, InLoadOrderLinks
);
523 if ((ULONG_PTR
)PcValue
>= (ULONG_PTR
)Module
->DllBase
&&
524 (ULONG_PTR
)PcValue
< (ULONG_PTR
)Module
->DllBase
+ Module
->SizeOfImage
)
526 ImageBase
= Module
->DllBase
;
529 Entry
= Entry
->Flink
;
531 RtlLeaveCriticalSection (NtCurrentPeb()->LoaderLock
);
533 *BaseOfImage
= ImageBase
;
543 RtlDosApplyFileIsolationRedirection_Ustr(IN ULONG Flags
,
544 IN PUNICODE_STRING OriginalName
,
545 IN PUNICODE_STRING Extension
,
546 IN OUT PUNICODE_STRING StaticString
,
547 IN OUT PUNICODE_STRING DynamicString
,
548 IN OUT PUNICODE_STRING
*NewName
,
550 IN PSIZE_T FileNameSize
,
551 IN PSIZE_T RequiredLength
)
553 return STATUS_SXS_KEY_NOT_FOUND
;
562 RtlWow64EnableFsRedirection(IN BOOLEAN Wow64FsEnableRedirection
)
564 /* This is what Windows returns on x86 */
565 return STATUS_NOT_IMPLEMENTED
;
574 RtlWow64EnableFsRedirectionEx(IN PVOID Wow64FsEnableRedirection
,
575 OUT PVOID
*OldFsRedirectionLevel
)
577 /* This is what Windows returns on x86 */
578 return STATUS_NOT_IMPLEMENTED
;
587 RtlComputeImportTableHash(IN HANDLE FileHandle
,
589 IN ULONG ImporTTableHashSize
)
592 return STATUS_NOT_IMPLEMENTED
;
598 _Out_writes_bytes_all_(Length
) VOID UNALIGNED
*Destination
,
599 _In_reads_bytes_(Length
) CONST VOID UNALIGNED
*Source
,
604 RtlCopyMemory(Destination
, Source
, Length
);
606 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
608 _SEH2_YIELD(return _SEH2_GetExceptionCode());
612 return STATUS_SUCCESS
;