1 /* $Id: object.c,v 1.52 2002/07/17 21:04:56 dwelch 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
,
188 ObjectAttributes
->Attributes
);
189 if (Status
== STATUS_REPARSE
)
191 /* reparse the object path */
192 NextObject
= RootObject
;
193 current
= PathString
.Buffer
;
195 ObReferenceObjectByPointer(NextObject
,
201 if (NextObject
== NULL
)
205 ObDereferenceObject(CurrentObject
);
206 CurrentObject
= NextObject
;
210 RtlCreateUnicodeString (RemainingPath
, current
);
211 RtlFreeUnicodeString (&PathString
);
212 *ReturnedObject
= CurrentObject
;
214 return(STATUS_SUCCESS
);
218 /**********************************************************************
229 ObCreateObject(OUT PHANDLE Handle
,
230 IN ACCESS_MASK DesiredAccess
,
231 IN POBJECT_ATTRIBUTES ObjectAttributes
,
232 IN POBJECT_TYPE Type
,
236 UNICODE_STRING RemainingPath
;
237 POBJECT_HEADER Header
;
238 POBJECT_HEADER ParentHeader
= NULL
;
240 BOOLEAN ObjectAttached
= FALSE
;
242 assert_irql(APC_LEVEL
);
244 DPRINT("ObCreateObject(Handle %x, ObjectAttributes %x, Type %x)\n",
245 Handle
, ObjectAttributes
, Type
);
246 if (ObjectAttributes
!= NULL
&&
247 ObjectAttributes
->ObjectName
!= NULL
)
249 DPRINT("ObjectAttributes->ObjectName->Buffer %S\n",
250 ObjectAttributes
->ObjectName
->Buffer
);
253 if (ObjectAttributes
!= NULL
&&
254 ObjectAttributes
->ObjectName
!= NULL
)
256 Status
= ObFindObject(ObjectAttributes
,
260 if (!NT_SUCCESS(Status
))
262 DPRINT("ObFindObject() failed! (Status 0x%x)\n", Status
);
268 RtlInitUnicodeString(&RemainingPath
, NULL
);
271 RtlMapGenericMask(&DesiredAccess
,
274 Header
= (POBJECT_HEADER
)ExAllocatePoolWithTag(NonPagedPool
,
275 OBJECT_ALLOC_SIZE(Type
),
277 ObInitializeObject(Header
,
285 ParentHeader
= BODY_TO_HEADER(Parent
);
288 if (ParentHeader
!= NULL
&&
289 ParentHeader
->ObjectType
== ObDirectoryType
&&
290 RemainingPath
.Buffer
!= NULL
)
292 ObpAddEntryDirectory(Parent
,
294 RemainingPath
.Buffer
+1);
295 ObjectAttached
= TRUE
;
298 if ((Header
->ObjectType
!= NULL
) &&
299 (Header
->ObjectType
->Create
!= NULL
))
301 DPRINT("Calling %x\n", Header
->ObjectType
->Create
);
302 Status
= Header
->ObjectType
->Create(HEADER_TO_BODY(Header
),
304 RemainingPath
.Buffer
,
306 if (!NT_SUCCESS(Status
))
308 if (ObjectAttached
== TRUE
)
310 ObpRemoveEntryDirectory(Header
);
314 ObDereferenceObject(Parent
);
316 RtlFreeUnicodeString(&Header
->Name
);
317 RtlFreeUnicodeString(&RemainingPath
);
322 RtlFreeUnicodeString( &RemainingPath
);
326 *Object
= HEADER_TO_BODY(Header
);
331 ObCreateHandle(PsGetCurrentProcess(),
334 ObjectAttributes
&& (ObjectAttributes
->Attributes
& OBJ_INHERIT
) ? TRUE
: FALSE
,
338 return(STATUS_SUCCESS
);
343 ObReferenceObjectByPointer(IN PVOID Object
,
344 IN ACCESS_MASK DesiredAccess
,
345 IN POBJECT_TYPE ObjectType
,
346 IN KPROCESSOR_MODE AccessMode
)
348 * FUNCTION: Increments the pointer reference count for a given object
350 * ObjectBody = Object's body
351 * DesiredAccess = Desired access to the object
352 * ObjectType = Points to the object type structure
353 * AccessMode = Type of access check to perform
357 POBJECT_HEADER Header
;
359 // DPRINT("ObReferenceObjectByPointer(Object %x, ObjectType %x)\n",
360 // Object,ObjectType);
362 Header
= BODY_TO_HEADER(Object
);
364 if (ObjectType
!= NULL
&& Header
->ObjectType
!= ObjectType
)
366 DPRINT("Failed %x (type was %x %S) should be %x %S\n",
369 Header
->ObjectType
->TypeName
.Buffer
,
371 ObjectType
->TypeName
.Buffer
);
372 return(STATUS_UNSUCCESSFUL
);
374 if (Header
->ObjectType
== PsProcessType
)
376 DPRINT("Ref p 0x%x refcount %d type %x ",
377 Object
, Header
->RefCount
, PsProcessType
);
378 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
380 if (Header
->ObjectType
== PsThreadType
)
382 DPRINT("Deref t 0x%x with refcount %d type %x ",
383 Object
, Header
->RefCount
, PsThreadType
);
384 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
387 InterlockedIncrement(&Header
->RefCount
);
389 return(STATUS_SUCCESS
);
394 ObOpenObjectByPointer(IN POBJECT Object
,
395 IN ULONG HandleAttributes
,
396 IN PACCESS_STATE PassedAccessState
,
397 IN ACCESS_MASK DesiredAccess
,
398 IN POBJECT_TYPE ObjectType
,
399 IN KPROCESSOR_MODE AccessMode
,
404 DPRINT("ObOpenObjectByPointer()\n");
406 Status
= ObReferenceObjectByPointer(Object
,
410 if (!NT_SUCCESS(Status
))
415 Status
= ObCreateHandle(PsGetCurrentProcess(),
418 HandleAttributes
& OBJ_INHERIT
,
421 ObDereferenceObject(Object
);
423 return STATUS_SUCCESS
;
428 ObpPerformRetentionChecks(POBJECT_HEADER Header
)
430 // DPRINT("ObPerformRetentionChecks(Header %x), RefCount %d, HandleCount %d\n",
431 // Header,Header->RefCount,Header->HandleCount);
433 if (Header
->RefCount
< 0)
435 CPRINT("Object %x/%x has invalid reference count (%d)\n",
436 Header
, HEADER_TO_BODY(Header
), Header
->RefCount
);
439 if (Header
->HandleCount
< 0)
441 CPRINT("Object %x/%x has invalid handle count (%d)\n",
442 Header
, HEADER_TO_BODY(Header
), Header
->HandleCount
);
446 if (Header
->RefCount
== 0 &&
447 Header
->HandleCount
== 0 &&
448 Header
->Permanent
== FALSE
)
450 if (Header
->ObjectType
!= NULL
&&
451 Header
->ObjectType
->Delete
!= NULL
)
453 Header
->ObjectType
->Delete(HEADER_TO_BODY(Header
));
455 if (Header
->Name
.Buffer
!= NULL
)
457 ObpRemoveEntryDirectory(Header
);
458 RtlFreeUnicodeString(&Header
->Name
);
460 DPRINT("ObPerformRetentionChecks() = Freeing object\n");
463 return(STATUS_SUCCESS
);
467 /**********************************************************************
469 * ObfReferenceObject@4
472 * Increments a given object's reference count and performs
476 * ObjectBody = Body of the object.
482 ObfReferenceObject(IN PVOID Object
)
484 POBJECT_HEADER Header
;
488 Header
= BODY_TO_HEADER(Object
);
490 InterlockedIncrement(&Header
->RefCount
);
492 ObpPerformRetentionChecks(Header
);
496 /**********************************************************************
498 * ObfDereferenceObject@4
501 * Decrements a given object's reference count and performs
505 * ObjectBody = Body of the object.
511 ObfDereferenceObject(IN PVOID Object
)
513 POBJECT_HEADER Header
;
514 extern POBJECT_TYPE PsProcessType
;
518 Header
= BODY_TO_HEADER(Object
);
520 if (Header
->ObjectType
== PsProcessType
)
522 DPRINT("Deref p 0x%x with refcount %d type %x ",
523 Object
, Header
->RefCount
, PsProcessType
);
524 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
526 if (Header
->ObjectType
== PsThreadType
)
528 DPRINT("Deref t 0x%x with refcount %d type %x ",
529 Object
, Header
->RefCount
, PsThreadType
);
530 DPRINT("eip %x\n", ((PULONG
)&Object
)[-1]);
533 InterlockedDecrement(&Header
->RefCount
);
535 ObpPerformRetentionChecks(Header
);
539 /**********************************************************************
541 * ObGetObjectPointerCount@4
544 * Retrieves the pointer(reference) count of the given object.
547 * ObjectBody = Body of the object.
553 ObGetObjectPointerCount(PVOID Object
)
555 POBJECT_HEADER Header
;
558 Header
= BODY_TO_HEADER(Object
);
560 return(Header
->RefCount
);
564 /**********************************************************************
566 * ObGetObjectHandleCount@4
569 * Retrieves the handle count of the given object.
572 * ObjectBody = Body of the object.
578 ObGetObjectHandleCount(PVOID Object
)
580 POBJECT_HEADER Header
;
583 Header
= BODY_TO_HEADER(Object
);
585 return(Header
->HandleCount
);