1 /* $Id: object.c,v 1.47 2002/05/07 22:39:26 hbirr Exp $
3 * COPYRIGHT: See COPYING in the top level directory
4 * PROJECT: ReactOS kernel
5 * FILE: ntoskrnl/ob/object.c
6 * PURPOSE: Implements generic object managment functions
7 * PROGRAMMER: David Welch (welch@cwcom.net)
12 /* INCLUDES *****************************************************************/
14 #include <ddk/ntddk.h>
16 #include <internal/ob.h>
17 #include <internal/ps.h>
18 #include <internal/id.h>
19 #include <internal/ke.h>
22 #include <internal/debug.h>
24 /* FUNCTIONS ************************************************************/
26 PVOID
HEADER_TO_BODY(POBJECT_HEADER obj
)
28 return(((void *)obj
)+sizeof(OBJECT_HEADER
)-sizeof(COMMON_BODY_HEADER
));
31 POBJECT_HEADER
BODY_TO_HEADER(PVOID body
)
33 PCOMMON_BODY_HEADER chdr
= (PCOMMON_BODY_HEADER
)body
;
34 return(CONTAINING_RECORD((&(chdr
->Type
)),OBJECT_HEADER
,Type
));
38 /**********************************************************************
48 VOID
ObInitializeObject(POBJECT_HEADER ObjectHeader
,
50 ACCESS_MASK DesiredAccess
,
52 POBJECT_ATTRIBUTES ObjectAttributes
)
54 ObjectHeader
->HandleCount
= 0;
55 ObjectHeader
->RefCount
= 1;
56 ObjectHeader
->ObjectType
= Type
;
57 if (ObjectAttributes
!= NULL
&&
58 ObjectAttributes
->Attributes
& OBJ_PERMANENT
)
60 ObjectHeader
->Permanent
= TRUE
;
64 ObjectHeader
->Permanent
= FALSE
;
66 RtlInitUnicodeString(&(ObjectHeader
->Name
),NULL
);
69 ObCreateHandle(PsGetCurrentProcess(),
70 HEADER_TO_BODY(ObjectHeader
),
72 ObjectAttributes
&& (ObjectAttributes
->Attributes
& OBJ_INHERIT
) ? TRUE
: FALSE
,
78 /**********************************************************************
90 * Pointer to a unicode string that will contain the
91 * remaining path if the function returns successfully.
92 * The caller must free the buffer after use by calling
93 * RtlFreeUnicodeString ().
96 * Optional pointer to an object type. This is used to
97 * descide if a symbolic link object will be parsed or not.
101 NTSTATUS
ObFindObject(POBJECT_ATTRIBUTES ObjectAttributes
,
102 PVOID
* ReturnedObject
,
103 PUNICODE_STRING RemainingPath
,
104 POBJECT_TYPE ObjectType
)
109 POBJECT_HEADER CurrentHeader
;
113 UNICODE_STRING PathString
;
115 DPRINT("ObFindObject(ObjectAttributes %x, ReturnedObject %x, "
116 "RemainingPath %x)\n",ObjectAttributes
,ReturnedObject
,RemainingPath
);
117 DPRINT("ObjectAttributes->ObjectName %wZ\n",
118 ObjectAttributes
->ObjectName
);
120 RtlInitUnicodeString (RemainingPath
, NULL
);
122 if (ObjectAttributes
->RootDirectory
== NULL
)
124 ObReferenceObjectByPointer(NameSpaceRoot
,
128 CurrentObject
= NameSpaceRoot
;
132 Status
= ObReferenceObjectByHandle(ObjectAttributes
->RootDirectory
,
138 if (!NT_SUCCESS(Status
))
144 Path
= ObjectAttributes
->ObjectName
->Buffer
;
148 *ReturnedObject
= CurrentObject
;
149 return(STATUS_SUCCESS
);
152 if ((ObjectAttributes
->RootDirectory
== NULL
) && (Path
[0] != '\\'))
154 ObDereferenceObject(CurrentObject
);
155 return(STATUS_UNSUCCESSFUL
);
160 RtlCreateUnicodeString (&PathString
, Path
);
161 current
= PathString
.Buffer
;
165 RtlInitUnicodeString (&PathString
, NULL
);
169 RootObject
= CurrentObject
;
173 DPRINT("current %S\n",current
);
174 CurrentHeader
= BODY_TO_HEADER(CurrentObject
);
176 DPRINT("Current ObjectType %wZ\n",
177 &CurrentHeader
->ObjectType
->TypeName
);
179 if (CurrentHeader
->ObjectType
->Parse
== NULL
)
181 DPRINT("Current object can't parse\n");
184 Status
= CurrentHeader
->ObjectType
->Parse(CurrentObject
,
189 ObjectAttributes
->Attributes
);
190 if (Status
== STATUS_REPARSE
)
192 /* reparse the object path */
193 NextObject
= RootObject
;
194 current
= PathString
.Buffer
;
196 ObReferenceObjectByPointer(NextObject
,
202 if (NextObject
== NULL
)
206 ObDereferenceObject(CurrentObject
);
207 CurrentObject
= NextObject
;
211 RtlCreateUnicodeString (RemainingPath
, current
);
212 RtlFreeUnicodeString (&PathString
);
213 *ReturnedObject
= CurrentObject
;
215 return(STATUS_SUCCESS
);
219 /**********************************************************************
230 ObCreateObject(OUT PHANDLE Handle
,
231 IN ACCESS_MASK DesiredAccess
,
232 IN POBJECT_ATTRIBUTES ObjectAttributes
,
233 IN POBJECT_TYPE Type
,
237 UNICODE_STRING RemainingPath
;
238 POBJECT_HEADER Header
;
239 POBJECT_HEADER ParentHeader
= NULL
;
241 BOOLEAN ObjectAttached
= FALSE
;
243 assert_irql(APC_LEVEL
);
245 DPRINT("ObCreateObject(Handle %x, ObjectAttributes %x, Type %x)\n",
246 Handle
, ObjectAttributes
, Type
);
247 if (ObjectAttributes
!= NULL
&&
248 ObjectAttributes
->ObjectName
!= NULL
)
250 DPRINT("ObjectAttributes->ObjectName->Buffer %S\n",
251 ObjectAttributes
->ObjectName
->Buffer
);
254 if (ObjectAttributes
!= NULL
&&
255 ObjectAttributes
->ObjectName
!= NULL
)
257 Status
= ObFindObject(ObjectAttributes
,
261 if (!NT_SUCCESS(Status
))
263 DPRINT("ObFindObject() failed! (Status 0x%x)\n", Status
);
269 RtlInitUnicodeString(&RemainingPath
, NULL
);
272 RtlMapGenericMask(&DesiredAccess
,
275 Header
= (POBJECT_HEADER
)ExAllocatePoolWithTag(NonPagedPool
,
276 OBJECT_ALLOC_SIZE(Type
),
278 ObInitializeObject(Header
,
286 ParentHeader
= BODY_TO_HEADER(Parent
);
289 if (ParentHeader
!= NULL
&&
290 ParentHeader
->ObjectType
== ObDirectoryType
&&
291 RemainingPath
.Buffer
!= NULL
)
293 ObpAddEntryDirectory(Parent
,
295 RemainingPath
.Buffer
+1);
296 ObjectAttached
= TRUE
;
299 if ((Header
->ObjectType
!= NULL
) &&
300 (Header
->ObjectType
->Create
!= NULL
))
302 DPRINT("Calling %x\n", Header
->ObjectType
->Create
);
303 Status
= Header
->ObjectType
->Create(HEADER_TO_BODY(Header
),
305 RemainingPath
.Buffer
,
307 if (!NT_SUCCESS(Status
))
309 if (ObjectAttached
== TRUE
)
311 ObpRemoveEntryDirectory(Header
);
315 ObDereferenceObject(Parent
);
317 RtlFreeUnicodeString(&Header
->Name
);
318 RtlFreeUnicodeString(&RemainingPath
);
323 RtlFreeUnicodeString( &RemainingPath
);
325 *Object
= HEADER_TO_BODY(Header
);
327 return(STATUS_SUCCESS
);
332 ObReferenceObjectByPointer(IN PVOID Object
,
333 IN ACCESS_MASK DesiredAccess
,
334 IN POBJECT_TYPE ObjectType
,
335 IN KPROCESSOR_MODE AccessMode
)
337 * FUNCTION: Increments the pointer reference count for a given object
339 * ObjectBody = Object's body
340 * DesiredAccess = Desired access to the object
341 * ObjectType = Points to the object type structure
342 * AccessMode = Type of access check to perform
346 POBJECT_HEADER Header
;
348 // DPRINT("ObReferenceObjectByPointer(Object %x, ObjectType %x)\n",
349 // Object,ObjectType);
351 Header
= BODY_TO_HEADER(Object
);
353 if (ObjectType
!= NULL
&& Header
->ObjectType
!= ObjectType
)
355 DPRINT("Failed %x (type was %x %S) should be %x %S\n",
358 Header
->ObjectType
->TypeName
.Buffer
,
360 ObjectType
->TypeName
.Buffer
);
361 return(STATUS_UNSUCCESSFUL
);
363 if (Header
->ObjectType
== PsProcessType
)
365 DPRINT("Ref p 0x%x refcount %d type %x ",
366 Object
, Header
->RefCount
, PsProcessType
);
367 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
369 if (Header
->ObjectType
== PsThreadType
)
371 DPRINT("Deref t 0x%x with refcount %d type %x ",
372 Object
, Header
->RefCount
, PsThreadType
);
373 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
376 InterlockedIncrement(&Header
->RefCount
);
378 return(STATUS_SUCCESS
);
383 ObOpenObjectByPointer(IN POBJECT Object
,
384 IN ULONG HandleAttributes
,
385 IN PACCESS_STATE PassedAccessState
,
386 IN ACCESS_MASK DesiredAccess
,
387 IN POBJECT_TYPE ObjectType
,
388 IN KPROCESSOR_MODE AccessMode
,
393 DPRINT("ObOpenObjectByPointer()\n");
395 Status
= ObReferenceObjectByPointer(Object
,
399 if (!NT_SUCCESS(Status
))
404 Status
= ObCreateHandle(PsGetCurrentProcess(),
407 HandleAttributes
& OBJ_INHERIT
,
410 ObDereferenceObject(Object
);
412 return STATUS_SUCCESS
;
417 ObpPerformRetentionChecks(POBJECT_HEADER Header
)
419 // DPRINT("ObPerformRetentionChecks(Header %x), RefCount %d, HandleCount %d\n",
420 // Header,Header->RefCount,Header->HandleCount);
422 if (Header
->RefCount
< 0)
424 CPRINT("Object %x/%x has invalid reference count (%d)\n",
425 Header
, HEADER_TO_BODY(Header
), Header
->RefCount
);
428 if (Header
->HandleCount
< 0)
430 CPRINT("Object %x/%x has invalid handle count (%d)\n",
431 Header
, HEADER_TO_BODY(Header
), Header
->HandleCount
);
435 if (Header
->RefCount
== 0 &&
436 Header
->HandleCount
== 0 &&
437 Header
->Permanent
== FALSE
)
439 if (Header
->ObjectType
!= NULL
&&
440 Header
->ObjectType
->Delete
!= NULL
)
442 Header
->ObjectType
->Delete(HEADER_TO_BODY(Header
));
444 if (Header
->Name
.Buffer
!= NULL
)
446 ObpRemoveEntryDirectory(Header
);
447 RtlFreeUnicodeString(&Header
->Name
);
449 DPRINT("ObPerformRetentionChecks() = Freeing object\n");
452 return(STATUS_SUCCESS
);
456 /**********************************************************************
458 * ObfReferenceObject@4
461 * Increments a given object's reference count and performs
465 * ObjectBody = Body of the object.
471 ObfReferenceObject(IN PVOID Object
)
473 POBJECT_HEADER Header
;
477 Header
= BODY_TO_HEADER(Object
);
479 InterlockedIncrement(&Header
->RefCount
);
481 ObpPerformRetentionChecks(Header
);
485 /**********************************************************************
487 * ObfDereferenceObject@4
490 * Decrements a given object's reference count and performs
494 * ObjectBody = Body of the object.
500 ObfDereferenceObject(IN PVOID Object
)
502 POBJECT_HEADER Header
;
503 extern POBJECT_TYPE PsProcessType
;
507 Header
= BODY_TO_HEADER(Object
);
509 if (Header
->ObjectType
== PsProcessType
)
511 DPRINT("Deref p 0x%x with refcount %d type %x ",
512 Object
, Header
->RefCount
, PsProcessType
);
513 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
515 if (Header
->ObjectType
== PsThreadType
)
517 DPRINT("Deref t 0x%x with refcount %d type %x ",
518 Object
, Header
->RefCount
, PsThreadType
);
519 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
522 InterlockedDecrement(&Header
->RefCount
);
524 ObpPerformRetentionChecks(Header
);
528 /**********************************************************************
530 * ObGetObjectPointerCount@4
533 * Retrieves the pointer(reference) count of the given object.
536 * ObjectBody = Body of the object.
542 ObGetObjectPointerCount(PVOID Object
)
544 POBJECT_HEADER Header
;
547 Header
= BODY_TO_HEADER(Object
);
549 return(Header
->RefCount
);
553 /**********************************************************************
555 * ObGetObjectHandleCount@4
558 * Retrieves the handle count of the given object.
561 * ObjectBody = Body of the object.
567 ObGetObjectHandleCount(PVOID Object
)
569 POBJECT_HEADER Header
;
572 Header
= BODY_TO_HEADER(Object
);
574 return(Header
->HandleCount
);