Added ObGetObjectHandleCount().
[reactos.git] / reactos / ntoskrnl / ob / object.c
index d0a3278..7e78bfe 100644 (file)
@@ -1,4 +1,5 @@
-/*
+/* $Id: object.c,v 1.46 2002/03/05 00:19:28 ekohl Exp $
+ * 
  * COPYRIGHT:     See COPYING in the top level directory
  * PROJECT:       ReactOS kernel
  * FILE:          ntoskrnl/ob/object.c
 /* INCLUDES *****************************************************************/
 
 #include <ddk/ntddk.h>
+#include <roscfg.h>
 #include <internal/ob.h>
-#include <wstring.h>
-#include <string.h>
+#include <internal/ps.h>
+#include <internal/id.h>
+#include <internal/ke.h>
 
 #define NDEBUG
 #include <internal/debug.h>
 
 /* FUNCTIONS ************************************************************/
 
+PVOID HEADER_TO_BODY(POBJECT_HEADER obj)
+{
+   return(((void *)obj)+sizeof(OBJECT_HEADER)-sizeof(COMMON_BODY_HEADER));
+}
+
+POBJECT_HEADER BODY_TO_HEADER(PVOID body)
+{
+   PCOMMON_BODY_HEADER chdr = (PCOMMON_BODY_HEADER)body;
+   return(CONTAINING_RECORD((&(chdr->Type)),OBJECT_HEADER,Type));
+}
+
+
+/**********************************************************************
+ * NAME                                                        PRIVATE
+ *     ObInitializeObject
+ *
+ * DESCRIPTION
+ *
+ * ARGUMENTS
+ *
+ * RETURN VALUE
+ */
 VOID ObInitializeObject(POBJECT_HEADER ObjectHeader,
                        PHANDLE Handle,
                        ACCESS_MASK DesiredAccess,
                        POBJECT_TYPE Type,
                        POBJECT_ATTRIBUTES ObjectAttributes)
 {
-   ObjectHeader->HandleCount = 1;
+   ObjectHeader->HandleCount = 0;
    ObjectHeader->RefCount = 1;
    ObjectHeader->ObjectType = Type;
-   ObjectHeader->Permanent = FALSE;
+   if (ObjectAttributes != NULL &&
+       ObjectAttributes->Attributes & OBJ_PERMANENT)
+     {
+       ObjectHeader->Permanent = TRUE;
+     }
+   else
+     {
+       ObjectHeader->Permanent = FALSE;
+     }
    RtlInitUnicodeString(&(ObjectHeader->Name),NULL);
    if (Handle != NULL)
      {
@@ -41,22 +74,51 @@ VOID ObInitializeObject(POBJECT_HEADER ObjectHeader,
      }
 }
 
+
+/**********************************************************************
+ * NAME                                                        PRIVATE
+ *     ObFindObject@16
+ *
+ * DESCRIPTION
+ *
+ * ARGUMENTS
+ *     ObjectAttributes
+ *
+ *     ReturnedObject
+ *
+ *     RemainigPath
+ *             Pointer to a unicode string that will contain the
+ *             remaining path if the function returns successfully.
+ *             The caller must free the buffer after use by calling
+ *             RtlFreeUnicodeString ().
+ *
+ *     ObjectType
+ *             Optional pointer to an object type. This is used to
+ *             descide if a symbolic link object will be parsed or not.
+ *
+ * RETURN VALUE
+ */
 NTSTATUS ObFindObject(POBJECT_ATTRIBUTES ObjectAttributes,
                      PVOID* ReturnedObject,
-                     PWSTR* RemainingPath)
+                     PUNICODE_STRING RemainingPath,
+                     POBJECT_TYPE ObjectType)
 {
    PVOID NextObject;
    PVOID CurrentObject;
+   PVOID RootObject;
    POBJECT_HEADER CurrentHeader;
    NTSTATUS Status;
    PWSTR Path;
    PWSTR current;
+   UNICODE_STRING PathString;
    
    DPRINT("ObFindObject(ObjectAttributes %x, ReturnedObject %x, "
          "RemainingPath %x)\n",ObjectAttributes,ReturnedObject,RemainingPath);
-   DPRINT("ObjectAttributes->ObjectName->Buffer %x\n",
-         ObjectAttributes->ObjectName->Buffer);
-   
+   DPRINT("ObjectAttributes->ObjectName %wZ\n",
+         ObjectAttributes->ObjectName);
+
+   RtlInitUnicodeString (RemainingPath, NULL);
+
    if (ObjectAttributes->RootDirectory == NULL)
      {
        ObReferenceObjectByPointer(NameSpaceRoot,
@@ -87,23 +149,56 @@ NTSTATUS ObFindObject(POBJECT_ATTRIBUTES ObjectAttributes,
        return(STATUS_SUCCESS);
      }
    
-   if (Path[0] != '\\')
+   if ((ObjectAttributes->RootDirectory == NULL) && (Path[0] != '\\'))
      {
+       ObDereferenceObject(CurrentObject);
        return(STATUS_UNSUCCESSFUL);
      }
    
-   current = Path;
+   if (Path)
+     {
+       RtlCreateUnicodeString (&PathString, Path);
+       current = PathString.Buffer;
+     }
+   else
+     {
+       RtlInitUnicodeString (&PathString, NULL);
+       current = NULL;
+     }
+
+   RootObject = CurrentObject;
 
    while (TRUE)
      {
-       DPRINT("current %w\n",current);
+       DPRINT("current %S\n",current);
        CurrentHeader = BODY_TO_HEADER(CurrentObject);
+
+       DPRINT("Current ObjectType %wZ\n",
+              &CurrentHeader->ObjectType->TypeName);
+
        if (CurrentHeader->ObjectType->Parse == NULL)
          {
+            DPRINT("Current object can't parse\n");
             break;
          }
-       NextObject = CurrentHeader->ObjectType->Parse(CurrentObject,
-                                                     &current);
+       Status = CurrentHeader->ObjectType->Parse(CurrentObject,
+                                                 &NextObject,
+                                                 &PathString,
+                                                 &current,
+                                                 ObjectType,
+                                                 ObjectAttributes->Attributes);
+       if (Status == STATUS_REPARSE)
+         {
+            /* reparse the object path */
+            NextObject = RootObject;
+            current = PathString.Buffer;
+            
+            ObReferenceObjectByPointer(NextObject,
+                                       DIRECTORY_TRAVERSE,
+                                       NULL,
+                                       UserMode);
+         }
+
        if (NextObject == NULL)
          {
             break;
@@ -112,64 +207,132 @@ NTSTATUS ObFindObject(POBJECT_ATTRIBUTES ObjectAttributes,
        CurrentObject = NextObject;
      }
    
-   *RemainingPath = current;
+   if (current)
+      RtlCreateUnicodeString (RemainingPath, current);
+   RtlFreeUnicodeString (&PathString);
    *ReturnedObject = CurrentObject;
    
    return(STATUS_SUCCESS);
 }
 
-PVOID ObCreateObject(PHANDLE Handle,
-                    ACCESS_MASK DesiredAccess,
-                    POBJECT_ATTRIBUTES ObjectAttributes,
-                    POBJECT_TYPE Type)
+
+/**********************************************************************
+ * NAME                                                        EXPORTED
+ *     ObCreateObject@36
+ *
+ * DESCRIPTION
+ *
+ * ARGUMENTS
+ *
+ * RETURN VALUE
+ */
+NTSTATUS STDCALL
+ObCreateObject(OUT PHANDLE Handle,
+              IN ACCESS_MASK DesiredAccess,
+              IN POBJECT_ATTRIBUTES ObjectAttributes,
+              IN POBJECT_TYPE Type,
+              OUT PVOID *Object)
 {
-   PVOID Parent = NULL;
-   PWSTR RemainingPath = NULL;
-   POBJECT_HEADER Header;
-   NTSTATUS Status;
-   
-   DPRINT("ObCreateObject(Handle %x, ObjectAttributes %x, Type %x)\n");
-   if (ObjectAttributes != NULL &&
-       ObjectAttributes->ObjectName != NULL)
-     {
-       DPRINT("ObjectAttributes->ObjectName->Buffer %w\n",
-              ObjectAttributes->ObjectName->Buffer);
-     }
-   
-   if (ObjectAttributes != NULL &&
-       ObjectAttributes->ObjectName != NULL)
-     {
-       ObFindObject(ObjectAttributes,
-                    &Parent,
-                    &RemainingPath);
-     }
-   
-   Header = (POBJECT_HEADER)ExAllocatePool(NonPagedPool,
-                                          OBJECT_ALLOC_SIZE(Type));
-   ObInitializeObject(Header, 
-                     Handle, 
-                     DesiredAccess, 
-                     Type, 
-                     ObjectAttributes);
-   if (Header->ObjectType != NULL &&
-       Header->ObjectType->Create != NULL)
-     {
-       Status = Header->ObjectType->Create(HEADER_TO_BODY(Header),
-                                           Parent,
-                                           RemainingPath,
-                                           ObjectAttributes);
-       if (!NT_SUCCESS(Status))
-         {
-            return(NULL);
-         }
-     }
-   return(HEADER_TO_BODY(Header));
+  PVOID Parent = NULL;
+  UNICODE_STRING RemainingPath;
+  POBJECT_HEADER Header;
+  POBJECT_HEADER ParentHeader = NULL;
+  NTSTATUS Status;
+  BOOLEAN ObjectAttached = FALSE;
+
+  assert_irql(APC_LEVEL);
+
+  DPRINT("ObCreateObject(Handle %x, ObjectAttributes %x, Type %x)\n",
+        Handle, ObjectAttributes, Type);
+  if (ObjectAttributes != NULL &&
+      ObjectAttributes->ObjectName != NULL)
+    {
+      DPRINT("ObjectAttributes->ObjectName->Buffer %S\n",
+            ObjectAttributes->ObjectName->Buffer);
+    }
+
+  if (ObjectAttributes != NULL &&
+      ObjectAttributes->ObjectName != NULL)
+    {
+      Status = ObFindObject(ObjectAttributes,
+                           &Parent,
+                           &RemainingPath,
+                           NULL);
+      if (!NT_SUCCESS(Status))
+       {
+         DPRINT("ObFindObject() failed! (Status 0x%x)\n", Status);
+         return(Status);
+       }
+    }
+  else
+    {
+      RtlInitUnicodeString(&RemainingPath, NULL);
+    }
+
+  RtlMapGenericMask(&DesiredAccess,
+                   Type->Mapping);
+
+  Header = (POBJECT_HEADER)ExAllocatePoolWithTag(NonPagedPool,
+                                                OBJECT_ALLOC_SIZE(Type),
+                                                Type->Tag);
+  ObInitializeObject(Header,
+                    Handle,
+                    DesiredAccess,
+                    Type,
+                    ObjectAttributes);
+
+  if (Parent != NULL)
+    {
+      ParentHeader = BODY_TO_HEADER(Parent);
+    }
+
+  if (ParentHeader != NULL &&
+      ParentHeader->ObjectType == ObDirectoryType &&
+      RemainingPath.Buffer != NULL)
+    {
+      ObpAddEntryDirectory(Parent,
+                          Header,
+                          RemainingPath.Buffer+1);
+      ObjectAttached = TRUE;
+    }
+
+  if ((Header->ObjectType != NULL) &&
+      (Header->ObjectType->Create != NULL))
+    {
+      DPRINT("Calling %x\n", Header->ObjectType->Create);
+      Status = Header->ObjectType->Create(HEADER_TO_BODY(Header),
+                                         Parent,
+                                         RemainingPath.Buffer,
+                                         ObjectAttributes);
+      if (!NT_SUCCESS(Status))
+       {
+         if (ObjectAttached == TRUE)
+           {
+             ObpRemoveEntryDirectory(Header);
+           }
+         if (Parent)
+           {
+             ObDereferenceObject(Parent);
+           }
+         RtlFreeUnicodeString(&Header->Name);
+         RtlFreeUnicodeString(&RemainingPath);
+         ExFreePool(Header);
+         return(Status);
+       }
+    }
+  RtlFreeUnicodeString( &RemainingPath );
+
+  *Object = HEADER_TO_BODY(Header);
+
+  return(STATUS_SUCCESS);
 }
 
-NTSTATUS ObReferenceObjectByPointer(PVOID ObjectBody,
-                                   ACCESS_MASK DesiredAccess,
-                                   POBJECT_TYPE ObjectType,
-                                   KPROCESSOR_MODE AccessMode)
+
+NTSTATUS STDCALL
+ObReferenceObjectByPointer(IN PVOID Object,
+                          IN ACCESS_MASK DesiredAccess,
+                          IN POBJECT_TYPE ObjectType,
+                          IN KPROCESSOR_MODE AccessMode)
 /*
  * FUNCTION: Increments the pointer reference count for a given object
  * ARGUMENTS:
@@ -180,65 +343,235 @@ NTSTATUS ObReferenceObjectByPointer(PVOID ObjectBody,
  * RETURNS: Status
  */
 {
-   POBJECT_HEADER ObjectHeader;
+   POBJECT_HEADER Header;
 
-   DPRINT("ObReferenceObjectByPointer(ObjectBody %x, ObjectType %x)\n",
-         ObjectBody,ObjectType);
+//   DPRINT("ObReferenceObjectByPointer(Object %x, ObjectType %x)\n",
+//       Object,ObjectType);
    
-   ObjectHeader = BODY_TO_HEADER(ObjectBody);
+   Header = BODY_TO_HEADER(Object);
    
-   if (ObjectType != NULL && ObjectHeader->ObjectType != ObjectType)
+   if (ObjectType != NULL && Header->ObjectType != ObjectType)
      {
-       DPRINT("Failed (type was %x %w)\n",ObjectHeader->ObjectType,
-              ObjectHeader->ObjectType->TypeName.Buffer);
+       DPRINT("Failed %x (type was %x %S) should be %x %S\n",
+               Header,
+               Header->ObjectType,
+               Header->ObjectType->TypeName.Buffer,
+               ObjectType,
+    ObjectType->TypeName.Buffer);
        return(STATUS_UNSUCCESSFUL);
      }
+   if (Header->ObjectType == PsProcessType)
+     {
+       DPRINT("Ref p 0x%x refcount %d type %x ",
+               Object, Header->RefCount, PsProcessType);
+       DPRINT("eip %x\n", ((PULONG)&Object)[-1]);
+     }
+   if (Header->ObjectType == PsThreadType)
+     {
+       DPRINT("Deref t 0x%x with refcount %d type %x ",
+               Object, Header->RefCount, PsThreadType);
+       DPRINT("eip %x\n", ((PULONG)&Object)[-1]);
+     }
+   
+   Header->RefCount++;
    
-   ObjectHeader->RefCount++;
    return(STATUS_SUCCESS);
 }
 
-NTSTATUS ObPerformRetentionChecks(POBJECT_HEADER Header)
+
+NTSTATUS STDCALL
+ObOpenObjectByPointer(IN POBJECT Object,
+                     IN ULONG HandleAttributes,
+                     IN PACCESS_STATE PassedAccessState,
+                     IN ACCESS_MASK DesiredAccess,
+                     IN POBJECT_TYPE ObjectType,
+                     IN KPROCESSOR_MODE AccessMode,
+                     OUT PHANDLE Handle)
 {
-   DPRINT("ObPerformRetentionChecks(Header %x), RefCount %d, HandleCount %d\n",
-          Header,Header->RefCount,Header->HandleCount);
+   NTSTATUS Status;
    
-   if (Header->RefCount <  0 || Header->HandleCount < 0)
-     {
-       KeBugCheck(0);
-     }
+   DPRINT("ObOpenObjectByPointer()\n");
    
-   if (Header->RefCount == 0 && Header->HandleCount == 0 &&
-       !Header->Permanent)
+   Status = ObReferenceObjectByPointer(Object,
+                                      0,
+                                      ObjectType,
+                                      AccessMode);
+   if (!NT_SUCCESS(Status))
      {
-       if (Header->ObjectType != NULL &&
-           Header->ObjectType->Delete != NULL)
-         {
-            Header->ObjectType->Delete(HEADER_TO_BODY(Header));
-         }
-       if (Header->Name.Buffer != NULL)
-         {
-            ObRemoveEntry(Header);
-         }
-       DPRINT("ObPerformRetentionChecks() = Freeing object\n");
-       ExFreePool(Header);
+       return Status;
      }
-   return(STATUS_SUCCESS);
+   
+   Status = ObCreateHandle(PsGetCurrentProcess(),
+                          Object,
+                          DesiredAccess,
+                          FALSE,
+                          Handle);
+   
+   ObDereferenceObject(Object);
+   
+   return STATUS_SUCCESS;
 }
 
-VOID ObDereferenceObject(PVOID ObjectBody)
-/*
- * FUNCTION: Decrements a given object's reference count and performs
- * retention checks
- * ARGUMENTS:
- *        ObjectBody = Body of the object
+
+static NTSTATUS
+ObpPerformRetentionChecks(POBJECT_HEADER Header)
+{
+//  DPRINT("ObPerformRetentionChecks(Header %x), RefCount %d, HandleCount %d\n",
+//       Header,Header->RefCount,Header->HandleCount);
+  
+  if (Header->RefCount < 0)
+    {
+      CPRINT("Object %x/%x has invalid reference count (%d)\n",
+            Header, HEADER_TO_BODY(Header), Header->RefCount);
+      KeBugCheck(0);
+    }
+  if (Header->HandleCount < 0)
+    {
+      CPRINT("Object %x/%x has invalid handle count (%d)\n",
+            Header, HEADER_TO_BODY(Header), Header->HandleCount);
+      KeBugCheck(0);
+    }
+  
+  if (Header->RefCount == 0 &&
+      Header->HandleCount == 0 &&
+      Header->Permanent == FALSE)
+    {
+      if (Header->ObjectType != NULL &&
+         Header->ObjectType->Delete != NULL)
+       {
+         Header->ObjectType->Delete(HEADER_TO_BODY(Header));
+       }
+      if (Header->Name.Buffer != NULL)
+       {
+         ObpRemoveEntryDirectory(Header);
+         RtlFreeUnicodeString(&Header->Name);
+       }
+      DPRINT("ObPerformRetentionChecks() = Freeing object\n");
+      ExFreePool(Header);
+    }
+  return(STATUS_SUCCESS);
+}
+
+
+/**********************************************************************
+ * NAME                                                        EXPORTED
+ *     ObfReferenceObject@4
+ *
+ * DESCRIPTION
+ *     Increments a given object's reference count and performs
+ *     retention checks.
+ *
+ * ARGUMENTS
+ *  ObjectBody = Body of the object.
+ *
+ * RETURN VALUE
+ *     None.
  */
+VOID FASTCALL
+ObfReferenceObject(IN PVOID Object)
 {
-   POBJECT_HEADER Header = BODY_TO_HEADER(ObjectBody);
-   
-   DPRINT("ObDeferenceObject(ObjectBody %x) RefCount %d\n",ObjectBody,
-         Header->RefCount);
-   
-   Header->RefCount--;
-   ObPerformRetentionChecks(Header);
+  POBJECT_HEADER Header;
+
+  assert(Object);
+
+  Header = BODY_TO_HEADER(Object);
+
+  Header->RefCount++;
+
+  ObpPerformRetentionChecks(Header);
+}
+
+
+/**********************************************************************
+ * NAME                                                        EXPORTED
+ *     ObfDereferenceObject@4
+ *
+ * DESCRIPTION
+ *     Decrements a given object's reference count and performs
+ *     retention checks.
+ *
+ * ARGUMENTS
+ *     ObjectBody = Body of the object.
+ *
+ * RETURN VALUE
+ *     None.
+ */
+VOID FASTCALL
+ObfDereferenceObject(IN PVOID Object)
+{
+  POBJECT_HEADER Header;
+  extern POBJECT_TYPE PsProcessType;
+
+  assert(Object);
+
+  Header = BODY_TO_HEADER(Object);
+
+  if (Header->ObjectType == PsProcessType)
+    {
+      DPRINT("Deref p 0x%x with refcount %d type %x ",
+            Object, Header->RefCount, PsProcessType);
+      DPRINT("eip %x\n", ((PULONG)&Object)[-1]);
+    }
+  if (Header->ObjectType == PsThreadType)
+    {
+      DPRINT("Deref t 0x%x with refcount %d type %x ",
+            Object, Header->RefCount, PsThreadType);
+      DPRINT("eip %x\n", ((PULONG)&Object)[-1]);
+    }
+  
+  Header->RefCount--;
+  
+  ObpPerformRetentionChecks(Header);
+}
+
+
+/**********************************************************************
+ * NAME                                                        EXPORTED
+ *     ObGetObjectPointerCount@4
+ *
+ * DESCRIPTION
+ *     Retrieves the pointer(reference) count of the given object.
+ *
+ * ARGUMENTS
+ *     ObjectBody = Body of the object.
+ *
+ * RETURN VALUE
+ *     Reference count.
+ */
+ULONG STDCALL
+ObGetObjectPointerCount(PVOID Object)
+{
+  POBJECT_HEADER Header;
+
+  assert(Object);
+  Header = BODY_TO_HEADER(Object);
+
+  return(Header->RefCount);
+}
+
+
+/**********************************************************************
+ * NAME                                                        INTERNAL
+ *     ObGetObjectHandleCount@4
+ *
+ * DESCRIPTION
+ *     Retrieves the handle count of the given object.
+ *
+ * ARGUMENTS
+ *     ObjectBody = Body of the object.
+ *
+ * RETURN VALUE
+ *     Reference count.
+ */
+ULONG
+ObGetObjectHandleCount(PVOID Object)
+{
+  POBJECT_HEADER Header;
+
+  assert(Object);
+  Header = BODY_TO_HEADER(Object);
+
+  return(Header->HandleCount);
 }
+
+/* EOF */