3 * COPYRIGHT: See COPYING in the top level directory
4 * PROJECT: ReactOS kernel
5 * FILE: ntoskrnl/ob/namespc.c
6 * PURPOSE: Manages the system namespace
8 * PROGRAMMERS: David Welch (welch@mcmail.com)
11 /* INCLUDES ***************************************************************/
15 #include <internal/debug.h>
17 extern ULONG NtGlobalFlag
;
19 /* GLOBALS ****************************************************************/
21 POBJECT_TYPE ObDirectoryType
= NULL
;
22 POBJECT_TYPE ObTypeObjectType
= NULL
;
24 PDIRECTORY_OBJECT NameSpaceRoot
= NULL
;
25 PDIRECTORY_OBJECT ObpTypeDirectoryObject
= NULL
;
26 /* FIXME: Move this somewhere else once devicemap support is in */
27 PDEVICE_MAP ObSystemDeviceMap
= NULL
;
28 KEVENT ObpDefaultObject
;
30 static GENERIC_MAPPING ObpDirectoryMapping
= {
31 STANDARD_RIGHTS_READ
|DIRECTORY_QUERY
|DIRECTORY_TRAVERSE
,
32 STANDARD_RIGHTS_WRITE
|DIRECTORY_CREATE_OBJECT
|DIRECTORY_CREATE_SUBDIRECTORY
,
33 STANDARD_RIGHTS_EXECUTE
|DIRECTORY_QUERY
|DIRECTORY_TRAVERSE
,
34 DIRECTORY_ALL_ACCESS
};
36 static GENERIC_MAPPING ObpTypeMapping
= {
38 STANDARD_RIGHTS_WRITE
,
39 STANDARD_RIGHTS_EXECUTE
,
44 ObpAllocateObject(POBJECT_CREATE_INFORMATION ObjectCreateInfo
,
45 PUNICODE_STRING ObjectName
,
46 POBJECT_TYPE ObjectType
,
48 POBJECT_HEADER
*ObjectHeader
);
50 /* FUNCTIONS **************************************************************/
56 ObReferenceObjectByName(PUNICODE_STRING ObjectPath
,
58 PACCESS_STATE PassedAccessState
,
59 ACCESS_MASK DesiredAccess
,
60 POBJECT_TYPE ObjectType
,
61 KPROCESSOR_MODE AccessMode
,
66 UNICODE_STRING RemainingPath
;
67 UNICODE_STRING ObjectName
;
68 OBJECT_CREATE_INFORMATION ObjectCreateInfo
;
73 /* Capture the name */
74 DPRINT("Capturing Name\n");
75 Status
= ObpCaptureObjectName(&ObjectName
, ObjectPath
, AccessMode
);
76 if (!NT_SUCCESS(Status
))
78 DPRINT("ObpCaptureObjectName() failed (Status %lx)\n", Status
);
83 * Create a fake ObjectCreateInfo structure. Note that my upcoming
84 * ObFindObject refactoring will remove the need for this hack.
86 ObjectCreateInfo
.RootDirectory
= NULL
;
87 ObjectCreateInfo
.Attributes
= Attributes
;
89 Status
= ObFindObject(&ObjectCreateInfo
,
95 if (ObjectName
.Buffer
) ExFreePool(ObjectName
.Buffer
);
97 if (!NT_SUCCESS(Status
))
101 DPRINT("RemainingPath.Buffer '%S' Object %p\n", RemainingPath
.Buffer
, Object
);
103 if (RemainingPath
.Buffer
!= NULL
|| Object
== NULL
)
105 DPRINT("Object %p\n", Object
);
107 RtlFreeUnicodeString (&RemainingPath
);
108 return(STATUS_OBJECT_NAME_NOT_FOUND
);
111 RtlFreeUnicodeString (&RemainingPath
);
112 return(STATUS_SUCCESS
);
116 /**********************************************************************
121 * Obtain a handle to an existing object.
145 ObOpenObjectByName(IN POBJECT_ATTRIBUTES ObjectAttributes
,
146 IN POBJECT_TYPE ObjectType
,
147 IN OUT PVOID ParseContext
,
148 IN KPROCESSOR_MODE AccessMode
,
149 IN ACCESS_MASK DesiredAccess
,
150 IN PACCESS_STATE PassedAccessState
,
153 UNICODE_STRING RemainingPath
;
155 UNICODE_STRING ObjectName
;
156 OBJECT_CREATE_INFORMATION ObjectCreateInfo
;
161 DPRINT("ObOpenObjectByName(...)\n");
163 /* Capture all the info */
164 DPRINT("Capturing Create Info\n");
165 Status
= ObpCaptureObjectAttributes(ObjectAttributes
,
170 if (!NT_SUCCESS(Status
))
172 DPRINT("ObpCaptureObjectAttributes() failed (Status %lx)\n", Status
);
176 Status
= ObFindObject(&ObjectCreateInfo
,
181 ObpReleaseCapturedAttributes(&ObjectCreateInfo
);
182 if (ObjectName
.Buffer
) ExFreePool(ObjectName
.Buffer
);
183 if (!NT_SUCCESS(Status
))
185 DPRINT("ObFindObject() failed (Status %lx)\n", Status
);
189 DPRINT("OBject: %x, Remaining Path: %wZ\n", Object
, &RemainingPath
);
192 RtlFreeUnicodeString(&RemainingPath
);
193 return STATUS_UNSUCCESSFUL
;
195 if (RemainingPath
.Buffer
!= NULL
)
197 if (wcschr(RemainingPath
.Buffer
+ 1, L
'\\') == NULL
)
198 Status
= STATUS_OBJECT_NAME_NOT_FOUND
;
200 Status
=STATUS_OBJECT_PATH_NOT_FOUND
;
201 RtlFreeUnicodeString(&RemainingPath
);
202 ObDereferenceObject(Object
);
206 Status
= ObpCreateHandle(PsGetCurrentProcess(),
212 ObDereferenceObject(Object
);
213 RtlFreeUnicodeString(&RemainingPath
);
220 ObQueryDeviceMapInformation(PEPROCESS Process
,
221 PPROCESS_DEVICEMAP_INFORMATION DeviceMapInfo
)
226 * FIXME: This is an ugly hack for now, to always return the System Device Map
227 * instead of returning the Process Device Map. Not important yet since we don't use it
230 /* FIXME: Acquire the DeviceMap Spinlock */
231 // KeAcquireSpinLock(DeviceMap->Lock, &OldIrql);
234 DeviceMapInfo
->Query
.DriveMap
= ObSystemDeviceMap
->DriveMap
;
235 RtlMoveMemory(DeviceMapInfo
->Query
.DriveType
, ObSystemDeviceMap
->DriveType
, sizeof(ObSystemDeviceMap
->DriveType
));
237 /* FIXME: Release the DeviceMap Spinlock */
238 // KeReleasepinLock(DeviceMap->Lock, OldIrql);
243 ObpAddEntryDirectory(PDIRECTORY_OBJECT Parent
,
244 POBJECT_HEADER Header
,
247 * FUNCTION: Add an entry to a namespace directory
249 * Parent = directory to add in
250 * Header = Header of the object to add the entry for
251 * Name = Name to give the entry
256 ASSERT(HEADER_TO_OBJECT_NAME(Header
));
257 HEADER_TO_OBJECT_NAME(Header
)->Directory
= Parent
;
259 KeAcquireSpinLock(&Parent
->Lock
, &oldlvl
);
260 InsertTailList(&Parent
->head
, &Header
->Entry
);
261 KeReleaseSpinLock(&Parent
->Lock
, oldlvl
);
267 ObpRemoveEntryDirectory(POBJECT_HEADER Header
)
269 * FUNCTION: Remove an entry from a namespace directory
271 * Header = Header of the object to remove
276 DPRINT("ObpRemoveEntryDirectory(Header %x)\n",Header
);
278 KeAcquireSpinLock(&(HEADER_TO_OBJECT_NAME(Header
)->Directory
->Lock
),&oldlvl
);
279 if (Header
->Entry
.Flink
&& Header
->Entry
.Blink
)
281 RemoveEntryList(&(Header
->Entry
));
282 Header
->Entry
.Flink
= Header
->Entry
.Blink
= NULL
;
284 KeReleaseSpinLock(&(HEADER_TO_OBJECT_NAME(Header
)->Directory
->Lock
),oldlvl
);
289 ObpCreateDirectory(OB_OPEN_REASON Reason
,
293 ACCESS_MASK GrantedAccess
)
295 PDIRECTORY_OBJECT Directory
= ObjectBody
;
297 if (Reason
== ObCreateHandle
)
299 InitializeListHead(&Directory
->head
);
300 KeInitializeSpinLock(&Directory
->Lock
);
303 return STATUS_SUCCESS
;
307 ObpFindEntryDirectory(PDIRECTORY_OBJECT DirectoryObject
,
311 PLIST_ENTRY current
= DirectoryObject
->head
.Flink
;
312 POBJECT_HEADER current_obj
;
314 DPRINT("ObFindEntryDirectory(dir %x, name %S)\n",DirectoryObject
, Name
);
318 return(DirectoryObject
);
320 if (Name
[0]=='.' && Name
[1]==0)
322 return(DirectoryObject
);
324 if (Name
[0]=='.' && Name
[1]=='.' && Name
[2]==0)
326 return(HEADER_TO_OBJECT_NAME(BODY_TO_HEADER(DirectoryObject
))->Directory
);
328 while (current
!=(&(DirectoryObject
->head
)))
330 current_obj
= CONTAINING_RECORD(current
,OBJECT_HEADER
,Entry
);
331 DPRINT(" Scanning: %S for: %S\n",HEADER_TO_OBJECT_NAME(current_obj
)->Name
.Buffer
, Name
);
332 if (Attributes
& OBJ_CASE_INSENSITIVE
)
334 if (_wcsicmp(HEADER_TO_OBJECT_NAME(current_obj
)->Name
.Buffer
, Name
)==0)
336 DPRINT("Found it %x\n",¤t_obj
->Body
);
337 return(¤t_obj
->Body
);
342 if ( wcscmp(HEADER_TO_OBJECT_NAME(current_obj
)->Name
.Buffer
, Name
)==0)
344 DPRINT("Found it %x\n",¤t_obj
->Body
);
345 return(¤t_obj
->Body
);
348 current
= current
->Flink
;
350 DPRINT(" Not Found: %s() = NULL\n",__FUNCTION__
);
356 ObpParseDirectory(PVOID Object
,
358 PUNICODE_STRING FullPath
,
367 DPRINT("ObpParseDirectory(Object %x, Path %x, *Path %S)\n",
374 return STATUS_UNSUCCESSFUL
;
381 End
= wcschr(Start
, L
'\\');
387 KeAcquireSpinLock(&(((PDIRECTORY_OBJECT
)Object
)->Lock
), &oldlvl
);
388 FoundObject
= ObpFindEntryDirectory(Object
, Start
, Attributes
);
389 if (FoundObject
== NULL
)
391 KeReleaseSpinLock(&(((PDIRECTORY_OBJECT
)Object
)->Lock
), oldlvl
);
396 return STATUS_UNSUCCESSFUL
;
399 ObReferenceObjectByPointer(FoundObject
,
400 STANDARD_RIGHTS_REQUIRED
,
403 KeReleaseSpinLock(&(((PDIRECTORY_OBJECT
)Object
)->Lock
), oldlvl
);
414 *NextObject
= FoundObject
;
416 return STATUS_SUCCESS
;
423 OBJECT_ATTRIBUTES ObjectAttributes
;
425 SECURITY_DESCRIPTOR SecurityDescriptor
;
426 OBJECT_TYPE_INITIALIZER ObjectTypeInitializer
;
428 /* Initialize the security descriptor cache */
431 /* Initialize the Default Event */
432 KeInitializeEvent(&ObpDefaultObject
, NotificationEvent
, TRUE
);
434 /* Create the Type Type */
435 DPRINT("Creating Type Type\n");
436 RtlZeroMemory(&ObjectTypeInitializer
, sizeof(ObjectTypeInitializer
));
437 RtlInitUnicodeString(&Name
, L
"Type");
438 ObjectTypeInitializer
.Length
= sizeof(ObjectTypeInitializer
);
439 ObjectTypeInitializer
.ValidAccessMask
= OBJECT_TYPE_ALL_ACCESS
;
440 ObjectTypeInitializer
.UseDefaultObject
= TRUE
;
441 ObjectTypeInitializer
.MaintainTypeList
= TRUE
;
442 ObjectTypeInitializer
.PoolType
= NonPagedPool
;
443 ObjectTypeInitializer
.GenericMapping
= ObpTypeMapping
;
444 ObjectTypeInitializer
.DefaultNonPagedPoolCharge
= sizeof(OBJECT_TYPE
);
445 ObpCreateTypeObject(&ObjectTypeInitializer
, &Name
, &ObTypeObjectType
);
447 /* Create the Directory Type */
448 DPRINT("Creating Directory Type\n");
449 RtlZeroMemory(&ObjectTypeInitializer
, sizeof(ObjectTypeInitializer
));
450 RtlInitUnicodeString(&Name
, L
"Directory");
451 ObjectTypeInitializer
.Length
= sizeof(ObjectTypeInitializer
);
452 ObjectTypeInitializer
.ValidAccessMask
= DIRECTORY_ALL_ACCESS
;
453 ObjectTypeInitializer
.UseDefaultObject
= FALSE
;
454 ObjectTypeInitializer
.OpenProcedure
= ObpCreateDirectory
;
455 ObjectTypeInitializer
.ParseProcedure
= ObpParseDirectory
;
456 ObjectTypeInitializer
.MaintainTypeList
= FALSE
;
457 ObjectTypeInitializer
.GenericMapping
= ObpDirectoryMapping
;
458 ObjectTypeInitializer
.DefaultNonPagedPoolCharge
= sizeof(DIRECTORY_OBJECT
);
459 ObpCreateTypeObject(&ObjectTypeInitializer
, &Name
, &ObDirectoryType
);
461 /* Create security descriptor */
462 RtlCreateSecurityDescriptor(&SecurityDescriptor
,
463 SECURITY_DESCRIPTOR_REVISION1
);
464 RtlSetOwnerSecurityDescriptor(&SecurityDescriptor
,
467 RtlSetGroupSecurityDescriptor(&SecurityDescriptor
,
470 RtlSetDaclSecurityDescriptor(&SecurityDescriptor
,
475 /* Create root directory */
476 DPRINT("Creating Root Directory\n");
477 InitializeObjectAttributes(&ObjectAttributes
,
481 &SecurityDescriptor
);
482 ObCreateObject(KernelMode
,
487 sizeof(DIRECTORY_OBJECT
),
490 (PVOID
*)&NameSpaceRoot
);
491 ObInsertObject((PVOID
)NameSpaceRoot
,
493 DIRECTORY_ALL_ACCESS
,
498 /* Create '\ObjectTypes' directory */
499 RtlInitUnicodeString(&Name
, L
"\\ObjectTypes");
500 InitializeObjectAttributes(&ObjectAttributes
,
504 &SecurityDescriptor
);
505 ObCreateObject(KernelMode
,
510 sizeof(DIRECTORY_OBJECT
),
513 (PVOID
*)&ObpTypeDirectoryObject
);
514 ObInsertObject((PVOID
)ObpTypeDirectoryObject
,
516 DIRECTORY_ALL_ACCESS
,
521 /* Insert the two objects we already created but couldn't add */
522 /* NOTE: Uses TypeList & Creator Info in OB 2.0 */
523 ObpAddEntryDirectory(ObpTypeDirectoryObject
, BODY_TO_HEADER(ObTypeObjectType
), NULL
);
524 ObpAddEntryDirectory(ObpTypeDirectoryObject
, BODY_TO_HEADER(ObDirectoryType
), NULL
);
526 /* Create 'symbolic link' object type */
527 ObInitSymbolicLinkImplementation();
529 /* FIXME: Hack Hack! */
530 ObSystemDeviceMap
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(*ObSystemDeviceMap
), TAG('O', 'b', 'D', 'm'));
531 RtlZeroMemory(ObSystemDeviceMap
, sizeof(*ObSystemDeviceMap
));
536 ObpCreateTypeObject(POBJECT_TYPE_INITIALIZER ObjectTypeInitializer
,
537 PUNICODE_STRING TypeName
,
538 POBJECT_TYPE
*ObjectType
)
540 POBJECT_HEADER Header
;
541 POBJECT_TYPE LocalObjectType
;
545 DPRINT("ObpCreateTypeObject(ObjectType: %wZ)\n", TypeName
);
547 /* Allocate the Object */
548 Status
= ObpAllocateObject(NULL
,
551 OBJECT_ALLOC_SIZE(sizeof(OBJECT_TYPE
)),
553 if (!NT_SUCCESS(Status
))
555 DPRINT1("ObpAllocateObject failed!\n");
559 LocalObjectType
= (POBJECT_TYPE
)&Header
->Body
;
560 DPRINT("Local ObjectType: %p Header: %p \n", LocalObjectType
, Header
);
562 /* Check if this is the first Object Type */
563 if (!ObTypeObjectType
)
565 ObTypeObjectType
= LocalObjectType
;
566 Header
->Type
= ObTypeObjectType
;
567 LocalObjectType
->Key
= TAG('O', 'b', 'j', 'T');
572 Tag
[0] = TypeName
->Buffer
[0];
573 Tag
[1] = TypeName
->Buffer
[1];
574 Tag
[2] = TypeName
->Buffer
[2];
575 Tag
[3] = TypeName
->Buffer
[3];
578 DPRINT("Convert: %s \n", Tag
);
579 LocalObjectType
->Key
= *(PULONG
)Tag
;
583 LocalObjectType
->TypeInfo
= *ObjectTypeInitializer
;
584 LocalObjectType
->Name
= *TypeName
;
585 LocalObjectType
->TypeInfo
.PoolType
= ObjectTypeInitializer
->PoolType
;
587 /* These two flags need to be manually set up */
588 Header
->Flags
|= OB_FLAG_KERNEL_MODE
| OB_FLAG_PERMANENT
;
590 /* Check if we have to maintain a type list */
591 if (NtGlobalFlag
& FLG_MAINTAIN_OBJECT_TYPELIST
)
594 LocalObjectType
->TypeInfo
.MaintainTypeList
= TRUE
;
597 /* Calculate how much space our header'll take up */
598 HeaderSize
= sizeof(OBJECT_HEADER
) + sizeof(OBJECT_HEADER_NAME_INFO
) +
599 (ObjectTypeInitializer
->MaintainHandleCount
?
600 sizeof(OBJECT_HEADER_HANDLE_INFO
) : 0);
602 /* Update the Pool Charges */
603 if (ObjectTypeInitializer
->PoolType
== NonPagedPool
)
605 LocalObjectType
->TypeInfo
.DefaultNonPagedPoolCharge
+= HeaderSize
;
609 LocalObjectType
->TypeInfo
.DefaultPagedPoolCharge
+= HeaderSize
;
612 /* All objects types need a security procedure */
613 if (!ObjectTypeInitializer
->SecurityProcedure
)
615 LocalObjectType
->TypeInfo
.SecurityProcedure
= SeDefaultObjectMethod
;
618 /* Select the Wait Object */
619 if (LocalObjectType
->TypeInfo
.UseDefaultObject
)
621 /* Add the SYNCHRONIZE access mask since it's waitable */
622 LocalObjectType
->TypeInfo
.ValidAccessMask
|= SYNCHRONIZE
;
624 /* Use the "Default Object", a simple event */
625 LocalObjectType
->DefaultObject
= &ObpDefaultObject
;
627 /* Special system objects get an optimized hack so they can be waited on */
628 else if (TypeName
->Length
== 8 && !wcscmp(TypeName
->Buffer
, L
"File"))
630 LocalObjectType
->DefaultObject
= (PVOID
)FIELD_OFFSET(FILE_OBJECT
, Event
);
632 /* FIXME: When LPC stops sucking, add a hack for Waitable Ports */
635 /* No default Object */
636 LocalObjectType
->DefaultObject
= NULL
;
639 /* Initialize Object Type components */
640 ExInitializeResourceLite(&LocalObjectType
->Mutex
);
641 InitializeListHead(&LocalObjectType
->TypeList
);
643 /* Insert it into the Object Directory */
644 if (ObpTypeDirectoryObject
)
646 ObpAddEntryDirectory(ObpTypeDirectoryObject
, Header
, TypeName
->Buffer
);
647 ObReferenceObject(ObpTypeDirectoryObject
);
650 *ObjectType
= LocalObjectType
;