ReactOS 0.4.15-dev-6644-g539123c
registry.c File Reference
#include <freeldr.h>
#include <cmlib.h>
#include "registry.h"
#include <internal/cmboot.h>
#include <debug.h>
Include dependency graph for registry.c:

Go to the source code of this file.

Macros

#define HCI_TO_HKEY(CellIndex)   ((HKEY)(ULONG_PTR)(CellIndex))
 
#define GET_HHIVE(CmHive)   (&((CmHive)->Hive))
 
#define GET_HHIVE_FROM_HKEY(hKey)   GET_HHIVE(CmSystemHive)
 
#define GET_CM_KEY_NODE(hHive, hKey)   ((PCM_KEY_NODE)HvGetCell(hHive, HKEY_TO_HCI(hKey)))
 

Functions

 DBG_DEFAULT_CHANNEL (REGISTRY)
 
PVOID NTAPI CmpAllocate (IN SIZE_T Size, IN BOOLEAN Paged, IN ULONG Tag)
 
VOID NTAPI CmpFree (IN PVOID Ptr, IN ULONG Quota)
 
BOOLEAN RegImportBinaryHive (_In_ PVOID ChunkBase, _In_ ULONG ChunkSize)
 
BOOLEAN RegInitCurrentControlSet (_In_ BOOLEAN LastKnownGood)
 
static BOOLEAN GetNextPathElement (_Out_ PUNICODE_STRING NextElement, _Inout_ PUNICODE_STRING RemainingPath)
 
LONG RegOpenKey (_In_ HKEY ParentKey, _In_z_ PCWSTR KeyName, _Out_ PHKEY Key)
 
static VOID RepGetValueData (_In_ PHHIVE Hive, _In_ PCM_KEY_VALUE ValueCell, _Out_opt_ PULONG Type, _Out_opt_ PUCHAR Data, _Inout_opt_ PULONG DataSize)
 
LONG RegQueryValue (_In_ HKEY Key, _In_z_ PCWSTR ValueName, _Out_opt_ PULONG Type, _Out_opt_ PUCHAR Data, _Inout_opt_ PULONG DataSize)
 

Variables

static PCMHIVE CmSystemHive
 
static HCELL_INDEX SystemRootCell
 
PHHIVE SystemHive = NULL
 
HKEY CurrentControlSetKey = NULL
 

Macro Definition Documentation

◆ GET_CM_KEY_NODE

#define GET_CM_KEY_NODE (   hHive,
  hKey 
)    ((PCM_KEY_NODE)HvGetCell(hHive, HKEY_TO_HCI(hKey)))

Definition at line 42 of file registry.c.

◆ GET_HHIVE

#define GET_HHIVE (   CmHive)    (&((CmHive)->Hive))

Definition at line 40 of file registry.c.

◆ GET_HHIVE_FROM_HKEY

#define GET_HHIVE_FROM_HKEY (   hKey)    GET_HHIVE(CmSystemHive)

Definition at line 41 of file registry.c.

◆ HCI_TO_HKEY

#define HCI_TO_HKEY (   CellIndex)    ((HKEY)(ULONG_PTR)(CellIndex))

Definition at line 35 of file registry.c.

Function Documentation

◆ CmpAllocate()

PVOID NTAPI CmpAllocate ( IN SIZE_T  Size,
IN BOOLEAN  Paged,
IN ULONG  Tag 
)

Definition at line 46 of file registry.c.

50{
52 return FrLdrHeapAlloc(Size, Tag);
53}
FORCEINLINE PVOID FrLdrHeapAlloc(SIZE_T MemorySize, ULONG Tag)
Definition: mm.h:174
#define UNREFERENCED_PARAMETER(P)
Definition: ntbasedef.h:317
_Must_inspect_result_ _In_ WDFDEVICE _In_ BOOLEAN _In_opt_ PVOID Tag
Definition: wdfdevice.h:4065
_Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DEVICE_PROPERTY_DATA _In_ DEVPROPTYPE _In_ ULONG Size
Definition: wdfdevice.h:4533

Referenced by RegImportBinaryHive().

◆ CmpFree()

VOID NTAPI CmpFree ( IN PVOID  Ptr,
IN ULONG  Quota 
)

Definition at line 57 of file registry.c.

60{
63}
FORCEINLINE VOID FrLdrHeapFree(PVOID MemoryPointer, ULONG Tag)
Definition: mm.h:181
_Must_inspect_result_ _In_ PFSRTL_PER_STREAM_CONTEXT Ptr
Definition: fsrtlfuncs.h:898

Referenced by RegImportBinaryHive().

◆ DBG_DEFAULT_CHANNEL()

DBG_DEFAULT_CHANNEL ( REGISTRY  )

◆ GetNextPathElement()

static BOOLEAN GetNextPathElement ( _Out_ PUNICODE_STRING  NextElement,
_Inout_ PUNICODE_STRING  RemainingPath 
)
static

Definition at line 150 of file registry.c.

153{
154 /* Check if there are any characters left */
155 if (RemainingPath->Length < sizeof(WCHAR))
156 {
157 /* Nothing left, bail out early */
158 return FALSE;
159 }
160
161 /* The next path elements starts with the remaining path */
162 NextElement->Buffer = RemainingPath->Buffer;
163
164 /* Loop until the path element ends */
165 while ((RemainingPath->Length >= sizeof(WCHAR)) &&
166 (RemainingPath->Buffer[0] != '\\'))
167 {
168 /* Skip this character */
169 RemainingPath->Buffer++;
170 RemainingPath->Length -= sizeof(WCHAR);
171 }
172
173 NextElement->Length = (USHORT)(RemainingPath->Buffer - NextElement->Buffer) * sizeof(WCHAR);
174 NextElement->MaximumLength = NextElement->Length;
175
176 /* Check if the path element ended with a path separator */
177 if (RemainingPath->Length >= sizeof(WCHAR))
178 {
179 /* Skip the path separator */
180 ASSERT(RemainingPath->Buffer[0] == '\\');
181 RemainingPath->Buffer++;
182 RemainingPath->Length -= sizeof(WCHAR);
183 }
184
185 /* Return whether we got any characters */
186 return TRUE;
187}
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define ASSERT(a)
Definition: mode.c:44
unsigned short USHORT
Definition: pedump.c:61
__wchar_t WCHAR
Definition: xmlstorage.h:180

Referenced by RegOpenKey().

◆ RegImportBinaryHive()

BOOLEAN RegImportBinaryHive ( _In_ PVOID  ChunkBase,
_In_ ULONG  ChunkSize 
)

Definition at line 66 of file registry.c.

69{
71 PCM_KEY_NODE KeyNode;
72
73 TRACE("RegImportBinaryHive(%p, 0x%lx)\n", ChunkBase, ChunkSize);
74
75 /* Allocate and initialize the hive */
76 CmSystemHive = FrLdrTempAlloc(sizeof(CMHIVE), 'eviH');
78 HINIT_FLAT, // HINIT_MEMORY_INPLACE
79 0,
80 0,
81 ChunkBase,
83 CmpFree,
84 NULL,
85 NULL,
86 NULL,
87 NULL,
88 1,
89 NULL);
90 if (!NT_SUCCESS(Status))
91 {
92 ERR("Corrupted hive %p!\n", ChunkBase);
94 return FALSE;
95 }
96
97 /* Save the root key node */
101
102 /* Verify it is accessible */
104 ASSERT(KeyNode);
107
108 return TRUE;
109}
LONG NTSTATUS
Definition: precomp.h:26
#define ERR(fmt,...)
Definition: debug.h:110
FORCEINLINE PVOID FrLdrTempAlloc(_In_ SIZE_T Size, _In_ ULONG Tag)
Definition: mm.h:188
FORCEINLINE VOID FrLdrTempFree(PVOID Allocation, ULONG Tag)
Definition: mm.h:197
VOID NTAPI CmpFree(IN PVOID Ptr, IN ULONG Quota)
Definition: registry.c:57
#define GET_HHIVE(CmHive)
Definition: registry.c:40
static PCMHIVE CmSystemHive
Definition: registry.c:29
PHHIVE SystemHive
Definition: registry.c:32
static HCELL_INDEX SystemRootCell
Definition: registry.c:30
PVOID NTAPI CmpAllocate(IN SIZE_T Size, IN BOOLEAN Paged, IN ULONG Tag)
Definition: registry.c:46
struct _CM_KEY_NODE * PCM_KEY_NODE
#define CM_KEY_NODE_SIGNATURE
Definition: cmdata.h:21
#define HvReleaseCell(Hive, Cell)
Definition: cmlib.h:384
NTSTATUS CMAPI HvInitialize(PHHIVE RegistryHive, ULONG OperationType, ULONG HiveFlags, ULONG FileType, PVOID HiveData OPTIONAL, PALLOCATE_ROUTINE Allocate, PFREE_ROUTINE Free, PFILE_SET_SIZE_ROUTINE FileSetSize, PFILE_WRITE_ROUTINE FileWrite, PFILE_READ_ROUTINE FileRead, PFILE_FLUSH_ROUTINE FileFlush, ULONG Cluster OPTIONAL, PCUNICODE_STRING FileName OPTIONAL)
Definition: hiveinit.c:522
#define HvGetCell(Hive, Cell)
Definition: cmlib.h:381
#define NULL
Definition: types.h:112
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:32
Status
Definition: gdiplustypes.h:25
#define HINIT_FLAT
Definition: hivedata.h:17
#define HCELL_NIL
Definition: hivedata.h:85
#define TRACE(s)
Definition: solgame.cpp:4
Definition: cmlib.h:245
USHORT Signature
Definition: cmdata.h:92
HCELL_INDEX RootCell
Definition: hivedata.h:143
PHBASE_BLOCK BaseBlock
Definition: hivedata.h:303
_Inout_ PUCHAR _In_ PUCHAR _Out_ PUCHAR _Out_ PULONG ChunkSize
Definition: rtlfuncs.h:2277

Referenced by WinLdrInitSystemHive().

◆ RegInitCurrentControlSet()

BOOLEAN RegInitCurrentControlSet ( _In_ BOOLEAN  LastKnownGood)

Definition at line 112 of file registry.c.

114{
115 UNICODE_STRING ControlSetName;
116 HCELL_INDEX ControlCell;
117 PCM_KEY_NODE KeyNode;
118 BOOLEAN AutoSelect;
119
120 TRACE("RegInitCurrentControlSet\n");
121
122 /* Choose which control set to open and set it as the new "Current" */
123 RtlInitUnicodeString(&ControlSetName,
124 LastKnownGood ? L"LastKnownGood"
125 : L"Default");
126
127 ControlCell = CmpFindControlSet(SystemHive,
129 &ControlSetName,
130 &AutoSelect);
131 if (ControlCell == HCELL_NIL)
132 {
133 ERR("CmpFindControlSet('%wZ') failed\n", &ControlSetName);
134 return FALSE;
135 }
136
137 CurrentControlSetKey = HCI_TO_HKEY(ControlCell);
138
139 /* Verify it is accessible */
140 KeyNode = (PCM_KEY_NODE)HvGetCell(SystemHive, ControlCell);
141 ASSERT(KeyNode);
143 HvReleaseCell(SystemHive, ControlCell);
144
145 return TRUE;
146}
unsigned char BOOLEAN
HKEY CurrentControlSetKey
Definition: registry.c:33
#define HCI_TO_HKEY(CellIndex)
Definition: registry.c:35
HCELL_INDEX NTAPI CmpFindControlSet(_In_ PHHIVE SystemHive, _In_ HCELL_INDEX RootCell, _In_ PCUNICODE_STRING SelectKeyName, _Out_ PBOOLEAN AutoSelect)
Finds the corresponding "HKLM\SYSTEM\ControlSetXXX" system control set registry key,...
Definition: cmboot.c:84
ULONG HCELL_INDEX
Definition: hivedata.h:80
NTSYSAPI VOID NTAPI RtlInitUnicodeString(PUNICODE_STRING DestinationString, PCWSTR SourceString)
#define L(x)
Definition: ntvdm.h:50

Referenced by WinLdrInitSystemHive().

◆ RegOpenKey()

LONG RegOpenKey ( _In_ HKEY  ParentKey,
_In_z_ PCWSTR  KeyName,
_Out_ PHKEY  Key 
)

Definition at line 263 of file registry.c.

267{
268 UNICODE_STRING RemainingPath, SubKeyName;
269 UNICODE_STRING CurrentControlSet = RTL_CONSTANT_STRING(L"CurrentControlSet");
271 PCM_KEY_NODE KeyNode;
272 HCELL_INDEX CellIndex;
273
274 TRACE("RegOpenKey(%p, '%S', %p)\n", ParentKey, KeyName, Key);
275
276 /* Initialize the remaining path name */
277 RtlInitUnicodeString(&RemainingPath, KeyName);
278
279 /* Check if we have a parent key */
280 if (ParentKey == NULL)
281 {
282 UNICODE_STRING SubKeyName1, SubKeyName2, SubKeyName3;
284 UNICODE_STRING MachinePath = RTL_CONSTANT_STRING(L"MACHINE");
285 UNICODE_STRING SystemPath = RTL_CONSTANT_STRING(L"SYSTEM");
286
287 TRACE("RegOpenKey: absolute path\n");
288
289 if ((RemainingPath.Length < sizeof(WCHAR)) ||
290 RemainingPath.Buffer[0] != '\\')
291 {
292 /* The key path is not absolute */
293 ERR("RegOpenKey: invalid path '%S' (%wZ)\n", KeyName, &RemainingPath);
295 }
296
297 /* Skip initial path separator */
298 RemainingPath.Buffer++;
299 RemainingPath.Length -= sizeof(WCHAR);
300
301 /* Get the first 3 path elements */
302 GetNextPathElement(&SubKeyName1, &RemainingPath);
303 GetNextPathElement(&SubKeyName2, &RemainingPath);
304 GetNextPathElement(&SubKeyName3, &RemainingPath);
305 TRACE("RegOpenKey: %wZ / %wZ / %wZ\n", &SubKeyName1, &SubKeyName2, &SubKeyName3);
306
307 /* Check if we have the correct path */
308 if (!RtlEqualUnicodeString(&SubKeyName1, &RegistryPath, TRUE) ||
309 !RtlEqualUnicodeString(&SubKeyName2, &MachinePath, TRUE) ||
310 !RtlEqualUnicodeString(&SubKeyName3, &SystemPath, TRUE))
311 {
312 /* The key path is not inside HKLM\Machine\System */
313 ERR("RegOpenKey: invalid path '%S' (%wZ)\n", KeyName, &RemainingPath);
315 }
316
317 /* Use the root key */
318 CellIndex = SystemRootCell;
319 }
320 else
321 {
322 /* Use the parent key */
323 CellIndex = HKEY_TO_HCI(ParentKey);
324 }
325
326 /* Check if this is the root key */
327 if (CellIndex == SystemRootCell)
328 {
329 UNICODE_STRING TempPath = RemainingPath;
330
331 /* Get the first path element */
332 GetNextPathElement(&SubKeyName, &TempPath);
333
334 /* Check if this is CurrentControlSet */
335 if (RtlEqualUnicodeString(&SubKeyName, &CurrentControlSet, TRUE))
336 {
337 /* Use the CurrentControlSetKey and update the remaining path */
339 RemainingPath = TempPath;
340 }
341 }
342
343 /* Get the key node */
344 KeyNode = (PCM_KEY_NODE)HvGetCell(Hive, CellIndex);
345 ASSERT(KeyNode);
347
348 TRACE("RegOpenKey: RemainingPath '%wZ'\n", &RemainingPath);
349
350 /* Loop while there are path elements */
351 while (GetNextPathElement(&SubKeyName, &RemainingPath))
352 {
353 HCELL_INDEX NextCellIndex;
354
355 TRACE("RegOpenKey: next element '%wZ'\n", &SubKeyName);
356
357 /* Get the next sub key */
358 NextCellIndex = CmpFindSubKeyByName(Hive, KeyNode, &SubKeyName);
359 HvReleaseCell(Hive, CellIndex);
360 CellIndex = NextCellIndex;
361 if (CellIndex == HCELL_NIL)
362 {
363 WARN("Did not find sub key '%wZ' (full: %S)\n", &SubKeyName, KeyName);
365 }
366
367 /* Get the found key */
368 KeyNode = (PCM_KEY_NODE)HvGetCell(Hive, CellIndex);
369 ASSERT(KeyNode);
371 }
372
373 HvReleaseCell(Hive, CellIndex);
374 *Key = HCI_TO_HKEY(CellIndex);
375
376 return ERROR_SUCCESS;
377}
#define WARN(fmt,...)
Definition: debug.h:112
static BOOLEAN GetNextPathElement(_Out_ PUNICODE_STRING NextElement, _Inout_ PUNICODE_STRING RemainingPath)
Definition: registry.c:150
#define GET_HHIVE_FROM_HKEY(hKey)
Definition: registry.c:41
#define HKEY_TO_HCI(hKey)
Definition: registry.h:28
HCELL_INDEX NTAPI CmpFindSubKeyByName(IN PHHIVE Hive, IN PCM_KEY_NODE Parent, IN PCUNICODE_STRING SearchName)
Definition: cmindex.c:683
#define ERROR_SUCCESS
Definition: deptool.c:10
_Must_inspect_result_ _Out_ PNDIS_STATUS _In_ NDIS_HANDLE _In_ PNDIS_STRING SubKeyName
Definition: ndis.h:4725
NTSYSAPI BOOLEAN NTAPI RtlEqualUnicodeString(PUNICODE_STRING String1, PUNICODE_STRING String2, BOOLEAN CaseInSensitive)
#define RTL_CONSTANT_STRING(s)
Definition: tunneltest.c:14
_Must_inspect_result_ _In_ WDFDEVICE _In_ PCUNICODE_STRING KeyName
Definition: wdfdevice.h:2699
_Must_inspect_result_ _In_ PDRIVER_OBJECT _In_ PCUNICODE_STRING RegistryPath
Definition: wdfdriver.h:215
_Must_inspect_result_ _In_opt_ WDFKEY ParentKey
Definition: wdfregistry.h:69
#define ERROR_PATH_NOT_FOUND
Definition: winerror.h:106

◆ RegQueryValue()

LONG RegQueryValue ( _In_ HKEY  Key,
_In_z_ PCWSTR  ValueName,
_Out_opt_ PULONG  Type,
_Out_opt_ PUCHAR  Data,
_Inout_opt_ PULONG  DataSize 
)

Definition at line 418 of file registry.c.

424{
426 PCM_KEY_NODE KeyNode;
427 PCM_KEY_VALUE ValueCell;
428 HCELL_INDEX CellIndex;
429 UNICODE_STRING ValueNameString;
430
431 TRACE("RegQueryValue(%p, '%S', %p, %p, %p)\n",
433
434 /* Get the key node */
435 KeyNode = GET_CM_KEY_NODE(Hive, Key);
436 ASSERT(KeyNode);
438
439 /* Initialize value name string */
440 RtlInitUnicodeString(&ValueNameString, ValueName);
441 CellIndex = CmpFindValueByName(Hive, KeyNode, &ValueNameString);
442 if (CellIndex == HCELL_NIL)
443 {
444 TRACE("RegQueryValue value not found in key (%.*s)\n",
445 KeyNode->NameLength, KeyNode->Name);
448 }
450
451 /* Get the value cell */
452 ValueCell = (PCM_KEY_VALUE)HvGetCell(Hive, CellIndex);
453 ASSERT(ValueCell != NULL);
454
455 RepGetValueData(Hive, ValueCell, Type, Data, DataSize);
456
457 HvReleaseCell(Hive, CellIndex);
458
459 return ERROR_SUCCESS;
460}
Type
Definition: Type.h:7
#define GET_CM_KEY_NODE(hHive, hKey)
Definition: registry.c:42
struct _CM_KEY_VALUE * PCM_KEY_VALUE
HCELL_INDEX NTAPI CmpFindValueByName(IN PHHIVE Hive, IN PCM_KEY_NODE KeyNode, IN PCUNICODE_STRING Name)
Definition: cmvalue.c:99
#define ERROR_FILE_NOT_FOUND
Definition: disk.h:79
_In_ NDIS_STATUS _In_ ULONG _In_ USHORT _In_opt_ PVOID _In_ ULONG DataSize
Definition: ndis.h:4755
static VOID RepGetValueData(IN PHHIVE Hive, IN PCM_KEY_VALUE ValueCell, OUT PULONG Type OPTIONAL, OUT PUCHAR Data OPTIONAL, IN OUT PULONG DataSize OPTIONAL)
Definition: registry.c:824
WCHAR Name[ANYSIZE_ARRAY]
Definition: cmdata.h:116
USHORT NameLength
Definition: cmdata.h:114
_Must_inspect_result_ _In_ WDFKEY _In_ PCUNICODE_STRING ValueName
Definition: wdfregistry.h:243

◆ RepGetValueData()

static VOID RepGetValueData ( _In_ PHHIVE  Hive,
_In_ PCM_KEY_VALUE  ValueCell,
_Out_opt_ PULONG  Type,
_Out_opt_ PUCHAR  Data,
_Inout_opt_ PULONG  DataSize 
)
static

Definition at line 381 of file registry.c.

387{
389 PVOID DataCell;
390
391 /* Does the caller want the type? */
392 if (Type != NULL)
393 *Type = ValueCell->Type;
394
395 /* Does the caller provide DataSize? */
396 if (DataSize != NULL)
397 {
398 // NOTE: CmpValueToData doesn't support big data (the function will
399 // bugcheck if so), FreeLdr is not supposed to read such data.
400 // If big data is needed, use instead CmpGetValueData.
401 // CmpGetValueData(Hive, ValueCell, DataSize, &DataCell, ...);
402 DataCell = CmpValueToData(Hive, ValueCell, &DataLength);
403
404 /* Does the caller want the data? */
405 if ((Data != NULL) && (*DataSize != 0))
406 {
408 DataCell,
410 }
411
412 /* Return the actual data length */
414 }
415}
_In_ ULONG _In_opt_ WDFREQUEST _In_opt_ PVOID _In_ size_t _In_ PVOID _In_ size_t _Out_ size_t * DataLength
Definition: cdrom.h:1444
PCELL_DATA NTAPI CmpValueToData(IN PHHIVE Hive, IN PCM_KEY_VALUE Value, OUT PULONG Length)
Definition: cmvalue.c:167
#define min(a, b)
Definition: monoChain.cc:55
#define RtlCopyMemory(Destination, Source, Length)
Definition: typedefs.h:263
uint32_t ULONG
Definition: typedefs.h:59

Referenced by RegQueryValue(), and RegQueryValueExW().

Variable Documentation

◆ CmSystemHive

PCMHIVE CmSystemHive
static

Definition at line 29 of file registry.c.

Referenced by RegImportBinaryHive(), and RegOpenKey().

◆ CurrentControlSetKey

◆ SystemHive

◆ SystemRootCell

HCELL_INDEX SystemRootCell
static

Definition at line 30 of file registry.c.

Referenced by RegImportBinaryHive(), RegInitCurrentControlSet(), and RegOpenKey().