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
;
18 /* FUNCTIONS ***************************************************************/
25 RtlWalkFrameChain(OUT PVOID
*Callers
,
29 /* Not implemented for user-mode */
35 RtlpCheckForActiveDebugger(BOOLEAN Type
)
37 return (NtCurrentPeb()->BeingDebugged
);
42 RtlpSetInDbgPrint(IN BOOLEAN NewValue
)
44 /* If we're setting it to false, do it and return */
45 if (NewValue
== FALSE
)
47 NtCurrentTeb()->InDbgPrint
= FALSE
;
51 /* Setting to true; check if it's not already */
52 if (NtCurrentTeb()->InDbgPrint
) return TRUE
;
54 /* Set it and return */
55 NtCurrentTeb()->InDbgPrint
= TRUE
;
71 RtlGetCurrentPeb(VOID
)
73 return NtCurrentPeb();
80 RtlAcquirePebLock(VOID
)
82 PPEB Peb
= NtCurrentPeb ();
83 Peb
->FastPebLockRoutine (Peb
->FastPebLock
);
90 RtlReleasePebLock(VOID
)
92 PPEB Peb
= NtCurrentPeb ();
93 Peb
->FastPebUnlockRoutine (Peb
->FastPebLock
);
101 RtlGetNtGlobalFlags(VOID
)
103 PPEB pPeb
= NtCurrentPeb();
104 return pPeb
->NtGlobalFlag
;
110 PRTL_CRITICAL_SECTION CriticalSection
)
112 return RtlDeleteCriticalSection(CriticalSection
);
118 PRTL_CRITICAL_SECTION CriticalSection
)
120 return RtlEnterCriticalSection(CriticalSection
);
125 RtlInitializeHeapLock(
126 PRTL_CRITICAL_SECTION CriticalSection
)
128 return RtlInitializeCriticalSection(CriticalSection
);
134 PRTL_CRITICAL_SECTION CriticalSection
)
136 return RtlLeaveCriticalSection(CriticalSection
);
141 RtlpAllocateMemory(UINT Bytes
,
144 UNREFERENCED_PARAMETER(Tag
);
146 return RtlAllocateHeap(RtlGetProcessHeap(),
154 RtlpFreeMemory(PVOID Mem
,
157 UNREFERENCED_PARAMETER(Tag
);
159 RtlFreeHeap(RtlGetProcessHeap(),
167 CHECK_PAGED_CODE_RTL(char *file
, int line
)
169 /* meaningless in user mode */
175 RtlpHandleDpcStackException(IN PEXCEPTION_REGISTRATION_RECORD RegistrationFrame
,
176 IN ULONG_PTR RegistrationFrameEnd
,
177 IN OUT PULONG_PTR StackLow
,
178 IN OUT PULONG_PTR StackHigh
)
180 /* There's no such thing as a DPC stack in user-mode */
186 RtlpCheckLogException(IN PEXCEPTION_RECORD ExceptionRecord
,
187 IN PCONTEXT ContextRecord
,
188 IN PVOID ContextData
,
191 /* Exception logging is not done in user-mode */
196 RtlpCaptureStackLimits(IN ULONG_PTR Ebp
,
197 IN ULONG_PTR
*StackBegin
,
198 IN ULONG_PTR
*StackEnd
)
201 *StackBegin
= (ULONG_PTR
)NtCurrentTeb()->Tib
.StackLimit
;
202 *StackEnd
= (ULONG_PTR
)NtCurrentTeb()->Tib
.StackBase
;
206 /* RTL Atom Tables ************************************************************/
208 typedef struct _RTL_ATOM_HANDLE
210 RTL_HANDLE_TABLE_ENTRY Handle
;
211 PRTL_ATOM_TABLE_ENTRY AtomEntry
;
212 } RTL_ATOM_HANDLE
, *PRTL_ATOM_HANDLE
;
215 RtlpInitAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
217 RtlInitializeCriticalSection(&AtomTable
->CriticalSection
);
218 return STATUS_SUCCESS
;
223 RtlpDestroyAtomTableLock(PRTL_ATOM_TABLE AtomTable
)
225 RtlDeleteCriticalSection(&AtomTable
->CriticalSection
);
230 RtlpLockAtomTable(PRTL_ATOM_TABLE AtomTable
)
232 RtlEnterCriticalSection(&AtomTable
->CriticalSection
);
238 RtlpUnlockAtomTable(PRTL_ATOM_TABLE AtomTable
)
240 RtlLeaveCriticalSection(&AtomTable
->CriticalSection
);
244 /* handle functions */
247 RtlpCreateAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
249 RtlInitializeHandleTable(0xCFFF,
250 sizeof(RTL_ATOM_HANDLE
),
251 &AtomTable
->RtlHandleTable
);
257 RtlpDestroyAtomHandleTable(PRTL_ATOM_TABLE AtomTable
)
259 RtlDestroyHandleTable(&AtomTable
->RtlHandleTable
);
263 RtlpAllocAtomTable(ULONG Size
)
265 return (PRTL_ATOM_TABLE
)RtlAllocateHeap(RtlGetProcessHeap(),
271 RtlpFreeAtomTable(PRTL_ATOM_TABLE AtomTable
)
273 RtlFreeHeap(RtlGetProcessHeap(),
278 PRTL_ATOM_TABLE_ENTRY
279 RtlpAllocAtomTableEntry(ULONG Size
)
281 return (PRTL_ATOM_TABLE_ENTRY
)RtlAllocateHeap(RtlGetProcessHeap(),
287 RtlpFreeAtomTableEntry(PRTL_ATOM_TABLE_ENTRY Entry
)
289 RtlFreeHeap(RtlGetProcessHeap(),
295 RtlpFreeAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
297 PRTL_HANDLE_TABLE_ENTRY RtlHandleEntry
;
299 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
300 (ULONG
)Entry
->HandleIndex
,
303 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
309 RtlpCreateAtomHandle(PRTL_ATOM_TABLE AtomTable
, PRTL_ATOM_TABLE_ENTRY Entry
)
312 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
314 RtlHandle
= RtlAllocateHandle(&AtomTable
->RtlHandleTable
,
316 if (RtlHandle
!= NULL
)
318 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
320 /* FIXME - Handle Indexes >= 0xC000 ?! */
321 if (HandleIndex
< 0xC000)
323 Entry
->HandleIndex
= (USHORT
)HandleIndex
;
324 Entry
->Atom
= 0xC000 + (USHORT
)HandleIndex
;
326 AtomHandle
->AtomEntry
= Entry
;
327 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
333 /* set the valid flag, otherwise RtlFreeHandle will fail! */
334 AtomHandle
->Handle
.Flags
= RTL_HANDLE_VALID
;
336 RtlFreeHandle(&AtomTable
->RtlHandleTable
,
344 PRTL_ATOM_TABLE_ENTRY
345 RtlpGetAtomEntry(PRTL_ATOM_TABLE AtomTable
, ULONG Index
)
347 PRTL_HANDLE_TABLE_ENTRY RtlHandle
;
349 if (RtlIsValidIndexHandle(&AtomTable
->RtlHandleTable
,
353 PRTL_ATOM_HANDLE AtomHandle
= (PRTL_ATOM_HANDLE
)RtlHandle
;
355 return AtomHandle
->AtomEntry
;
363 * Ldr Resource support code
366 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_name( IMAGE_RESOURCE_DIRECTORY
*dir
,
367 LPCWSTR name
, void *root
,
369 IMAGE_RESOURCE_DIRECTORY
*find_entry_by_id( IMAGE_RESOURCE_DIRECTORY
*dir
,
370 WORD id
, void *root
, int want_dir
);
371 IMAGE_RESOURCE_DIRECTORY
*find_first_entry( IMAGE_RESOURCE_DIRECTORY
*dir
,
372 void *root
, int want_dir
);
373 int push_language( USHORT
*list
, ULONG pos
, WORD lang
);
375 /**********************************************************************
378 * Find a resource entry
380 NTSTATUS
find_entry( PVOID BaseAddress
, LDR_RESOURCE_INFO
*info
,
381 ULONG level
, void **ret
, int want_dir
)
385 IMAGE_RESOURCE_DIRECTORY
*resdirptr
;
386 USHORT list
[9]; /* list of languages to try */
388 LCID user_lcid
, system_lcid
;
390 root
= RtlImageDirectoryEntryToData( BaseAddress
, TRUE
, IMAGE_DIRECTORY_ENTRY_RESOURCE
, &size
);
391 if (!root
) return STATUS_RESOURCE_DATA_NOT_FOUND
;
394 if (!level
--) goto done
;
395 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Type
, root
, want_dir
|| level
)))
396 return STATUS_RESOURCE_TYPE_NOT_FOUND
;
397 if (!level
--) return STATUS_SUCCESS
;
400 if (!(*ret
= find_entry_by_name( resdirptr
, (LPCWSTR
)info
->Name
, root
, want_dir
|| level
)))
401 return STATUS_RESOURCE_NAME_NOT_FOUND
;
402 if (!level
--) return STATUS_SUCCESS
;
403 if (level
) return STATUS_INVALID_PARAMETER
; /* level > 3 */
405 /* 1. specified language */
406 pos
= push_language( list
, pos
, info
->Language
);
408 /* 2. specified language with neutral sublanguage */
409 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(info
->Language
), SUBLANG_NEUTRAL
) );
411 /* 3. neutral language with neutral sublanguage */
412 pos
= push_language( list
, pos
, MAKELANGID( LANG_NEUTRAL
, SUBLANG_NEUTRAL
) );
414 /* if no explicitly specified language, try some defaults */
415 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
417 /* user defaults, unless SYS_DEFAULT sublanguage specified */
418 if (SUBLANGID(info
->Language
) != SUBLANG_SYS_DEFAULT
)
420 /* 4. current thread locale language */
421 pos
= push_language( list
, pos
, LANGIDFROMLCID(NtCurrentTeb()->CurrentLocale
) );
423 if (NT_SUCCESS(NtQueryDefaultLocale(TRUE
, &user_lcid
)))
425 /* 5. user locale language */
426 pos
= push_language( list
, pos
, LANGIDFROMLCID(user_lcid
) );
428 /* 6. user locale language with neutral sublanguage */
429 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(user_lcid
), SUBLANG_NEUTRAL
) );
433 /* now system defaults */
435 if (NT_SUCCESS(NtQueryDefaultLocale(FALSE
, &system_lcid
)))
437 /* 7. system locale language */
438 pos
= push_language( list
, pos
, LANGIDFROMLCID( system_lcid
) );
440 /* 8. system locale language with neutral sublanguage */
441 pos
= push_language( list
, pos
, MAKELANGID( PRIMARYLANGID(system_lcid
), SUBLANG_NEUTRAL
) );
445 pos
= push_language( list
, pos
, MAKELANGID( LANG_ENGLISH
, SUBLANG_DEFAULT
) );
449 for (i
= 0; i
< pos
; i
++)
450 if ((*ret
= find_entry_by_id( resdirptr
, list
[i
], root
, want_dir
))) return STATUS_SUCCESS
;
452 /* if no explicitly specified language, return the first entry */
453 if (PRIMARYLANGID(info
->Language
) == LANG_NEUTRAL
)
455 if ((*ret
= find_first_entry( resdirptr
, root
, want_dir
))) return STATUS_SUCCESS
;
457 return STATUS_RESOURCE_LANG_NOT_FOUND
;
461 return STATUS_SUCCESS
;