- Fix some formatting.
[reactos.git] / reactos / ntoskrnl / ex / event.c
index 5685ee1..6c0f9d0 100644 (file)
@@ -1,11 +1,10 @@
-/* 
+/*
  * COPYRIGHT:       See COPYING in the top level directory
- * PROJECT:         ReactOS kernel
- * FILE:            ntoskrnl/nt/event.c
- * PURPOSE:         Named event support
- * 
- * PROGRAMMERS:     Alex Ionescu(alex@relsoft.net) - Fixed bugs/commented
- *                  Philip Susi and David Welch
+ * PROJECT:         ReactOS Kernel
+ * FILE:            ntoskrnl/ex/event.c
+ * PURPOSE:         Event support
+ * PROGRAMMERS:     Alex Ionescu(alex@relsoft.net)
+ *                  Thomas Weidenmueller
  */
 
 /* INCLUDES *****************************************************************/
 #define NDEBUG
 #include <internal/debug.h>
 
+#if defined (ALLOC_PRAGMA)
+#pragma alloc_text(INIT, ExpInitializeEventImplementation)
+#endif
+
 /* GLOBALS *******************************************************************/
 
-POBJECT_TYPE EXPORTED ExEventObjectType = NULL;
+POBJECT_TYPE ExEventObjectType = NULL;
 
-static GENERIC_MAPPING ExpEventMapping = {
+GENERIC_MAPPING ExpEventMapping =
+{
     STANDARD_RIGHTS_READ | SYNCHRONIZE | EVENT_QUERY_STATE,
     STANDARD_RIGHTS_WRITE | SYNCHRONIZE | EVENT_MODIFY_STATE,
     STANDARD_RIGHTS_EXECUTE | SYNCHRONIZE | EVENT_QUERY_STATE,
     EVENT_ALL_ACCESS};
 
-static const INFORMATION_CLASS_INFO ExEventInfoClass[] = {
-    
+static const INFORMATION_CLASS_INFO ExEventInfoClass[] =
+{
     /* EventBasicInformation */
     ICI_SQ_SAME( sizeof(EVENT_BASIC_INFORMATION), sizeof(ULONG), ICIF_QUERY),
 };
 
 /* FUNCTIONS *****************************************************************/
 
-VOID 
+VOID
 INIT_FUNCTION
+NTAPI
 ExpInitializeEventImplementation(VOID)
 {
+    OBJECT_TYPE_INITIALIZER ObjectTypeInitializer;
+    UNICODE_STRING Name;
+    DPRINT("Creating Event Object Type\n");
+
     /* Create the Event Object Type */
-    ExEventObjectType = ExAllocatePool(NonPagedPool,sizeof(OBJECT_TYPE));
-    RtlInitUnicodeString(&ExEventObjectType->TypeName, L"Event");
-    ExEventObjectType->Tag = TAG('E', 'V', 'T', 'T');
-    ExEventObjectType->PeakObjects = 0;
-    ExEventObjectType->PeakHandles = 0;
-    ExEventObjectType->TotalObjects = 0;
-    ExEventObjectType->TotalHandles = 0;
-    ExEventObjectType->PagedPoolCharge = 0;
-    ExEventObjectType->NonpagedPoolCharge = sizeof(KEVENT);
-    ExEventObjectType->Mapping = &ExpEventMapping;
-    ExEventObjectType->Dump = NULL;
-    ExEventObjectType->Open = NULL;
-    ExEventObjectType->Close = NULL;
-    ExEventObjectType->Delete = NULL;
-    ExEventObjectType->Parse = NULL;
-    ExEventObjectType->Security = NULL;
-    ExEventObjectType->QueryName = NULL;
-    ExEventObjectType->OkayToClose = NULL;
-    ExEventObjectType->Create = NULL;
-    ExEventObjectType->DuplicationNotify = NULL;
-    ObpCreateTypeObject(ExEventObjectType);
+    RtlZeroMemory(&ObjectTypeInitializer, sizeof(ObjectTypeInitializer));
+    RtlInitUnicodeString(&Name, L"Event");
+    ObjectTypeInitializer.Length = sizeof(ObjectTypeInitializer);
+    ObjectTypeInitializer.DefaultNonPagedPoolCharge = sizeof(KEVENT);
+    ObjectTypeInitializer.GenericMapping = ExpEventMapping;
+    ObjectTypeInitializer.PoolType = NonPagedPool;
+    ObjectTypeInitializer.ValidAccessMask = EVENT_ALL_ACCESS;
+    ObpCreateTypeObject(&ObjectTypeInitializer, &Name, &ExEventObjectType);
 }
 
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtClearEvent(IN HANDLE EventHandle)
 {
     PKEVENT Event;
     NTSTATUS Status;
-    
     PAGED_CODE();
-   
+
     /* Reference the Object */
     Status = ObReferenceObjectByHandle(EventHandle,
                                        EVENT_MODIFY_STATE,
@@ -79,25 +74,24 @@ NtClearEvent(IN HANDLE EventHandle)
                                        ExGetPreviousMode(),
                                        (PVOID*)&Event,
                                        NULL);
-   
+
     /* Check for Success */
-    if(NT_SUCCESS(Status)) {
-        
+    if(NT_SUCCESS(Status))
+    {
         /* Clear the Event and Dereference */
         KeClearEvent(Event);
         ObDereferenceObject(Event);
     }
-   
+
     /* Return Status */
     return Status;
 }
 
-
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtCreateEvent(OUT PHANDLE EventHandle,
               IN ACCESS_MASK DesiredAccess,
               IN POBJECT_ATTRIBUTES ObjectAttributes  OPTIONAL,
@@ -108,27 +102,29 @@ NtCreateEvent(OUT PHANDLE EventHandle,
     PKEVENT Event;
     HANDLE hEvent;
     NTSTATUS Status = STATUS_SUCCESS;
-   
     PAGED_CODE();
-    DPRINT("NtCreateEvent(0x%x, 0x%x, 0x%x)\n", EventHandle, DesiredAccess, ObjectAttributes);
-    /* Check Output Safety */
-    if(PreviousMode != KernelMode) {
-        
-        _SEH_TRY {
-            
-            ProbeForWrite(EventHandle,
-                          sizeof(HANDLE),
-                          sizeof(ULONG));
-        } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-            
+    DPRINT("NtCreateEvent(0x%p, 0x%x, 0x%p)\n",
+            EventHandle, DesiredAccess, ObjectAttributes);
+
+    /* Check if we were called from user-mode */
+    if(PreviousMode != KernelMode)
+    {
+        /* Enter SEH Block */
+        _SEH_TRY
+        {
+            /* Check handle pointer */
+            ProbeForWriteHandle(EventHandle);
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-        
-        } _SEH_END;
-     
+        }
+        _SEH_END;
+
+        /* Bail out if pointer was invalid */
         if(!NT_SUCCESS(Status)) return Status;
     }
-    
+
     /* Create the Object */
     Status = ObCreateObject(PreviousMode,
                             ExEventObjectType,
@@ -139,15 +135,15 @@ NtCreateEvent(OUT PHANDLE EventHandle,
                             0,
                             0,
                             (PVOID*)&Event);
-    
+
     /* Check for Success */
-    if(NT_SUCCESS(Status)) {
-        
+    if(NT_SUCCESS(Status))
+    {
         /* Initalize the Event */
         KeInitializeEvent(Event,
                           EventType,
                           InitialState);
-        
+
         /* Insert it */
         Status = ObInsertObject((PVOID)Event,
                                  NULL,
@@ -156,19 +152,19 @@ NtCreateEvent(OUT PHANDLE EventHandle,
                                  NULL,
                                  &hEvent);
         ObDereferenceObject(Event);
+
         /* Check for success and return handle */
-        if(NT_SUCCESS(Status)) {
-            
-            _SEH_TRY {
-                
+        if(NT_SUCCESS(Status))
+        {
+            _SEH_TRY
+            {
                 *EventHandle = hEvent;
-            
-            } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-                
+            }
+            _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+            {
                 Status = _SEH_GetExceptionCode();
-                
-            _SEH_END;
+            }
+            _SEH_END;
         }
     }
 
@@ -179,8 +175,8 @@ NtCreateEvent(OUT PHANDLE EventHandle,
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtOpenEvent(OUT PHANDLE EventHandle,
             IN ACCESS_MASK DesiredAccess,
             IN POBJECT_ATTRIBUTES ObjectAttributes)
@@ -188,27 +184,29 @@ NtOpenEvent(OUT PHANDLE EventHandle,
     HANDLE hEvent;
     KPROCESSOR_MODE PreviousMode = ExGetPreviousMode();
     NTSTATUS Status = STATUS_SUCCESS;
-   
-    PAGED_CODE();    
-    DPRINT("NtOpenEvent(0x%x, 0x%x, 0x%x)\n", EventHandle, DesiredAccess, ObjectAttributes);
-
-    /* Check Output Safety */
-    if(PreviousMode != KernelMode) {
-        
-        _SEH_TRY {
-            
-            ProbeForWrite(EventHandle,
-                          sizeof(HANDLE),
-                          sizeof(ULONG));
-        } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-            
+    PAGED_CODE();
+    DPRINT("NtOpenEvent(0x%p, 0x%x, 0x%p)\n",
+            EventHandle, DesiredAccess, ObjectAttributes);
+
+    /* Check if we were called from user-mode */
+    if(PreviousMode != KernelMode)
+    {
+        /* Enter SEH Block */
+        _SEH_TRY
+        {
+            /* Check handle pointer */
+            ProbeForWriteHandle(EventHandle);
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-        
-        } _SEH_END;
-     
+        }
+        _SEH_END;
+
+        /* Bail out if pointer was invalid */
         if(!NT_SUCCESS(Status)) return Status;
     }
-    
+
     /* Open the Object */
     Status = ObOpenObjectByName(ObjectAttributes,
                                 ExEventObjectType,
@@ -217,21 +215,23 @@ NtOpenEvent(OUT PHANDLE EventHandle,
                                 DesiredAccess,
                                 NULL,
                                 &hEvent);
-             
-    /* Check for success and return handle */
-    if(NT_SUCCESS(Status)) {
-            
-        _SEH_TRY {
-            
+
+    /* Check for success */
+    if(NT_SUCCESS(Status))
+    {
+        /* Enter SEH for return */
+        _SEH_TRY
+        {
+            /* Return the handle to the caller */
             *EventHandle = hEvent;
-                
-        } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-            
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-            
-        _SEH_END;
+        }
+        _SEH_END;
     }
-   
+
     /* Return status */
     return Status;
 }
@@ -239,36 +239,37 @@ NtOpenEvent(OUT PHANDLE EventHandle,
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtPulseEvent(IN HANDLE EventHandle,
              OUT PLONG PreviousState OPTIONAL)
 {
     PKEVENT Event;
     KPROCESSOR_MODE PreviousMode = ExGetPreviousMode();
     NTSTATUS Status = STATUS_SUCCESS;
-   
     PAGED_CODE();
     DPRINT("NtPulseEvent(EventHandle 0%x PreviousState 0%x)\n",
             EventHandle, PreviousState);
 
-    /* Check buffer validity */
-    if(PreviousState && PreviousMode == UserMode) {
-        
-        _SEH_TRY {
-            
-            ProbeForWrite(PreviousState,
-                          sizeof(LONG),
-                          sizeof(ULONG));
-         } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-             
+    /* Check if we were called from user-mode */
+    if((PreviousState) && (PreviousMode != KernelMode))
+    {
+        /* Entry SEH Block */
+        _SEH_TRY
+        {
+            /* Make sure the state pointer is valid */
+            ProbeForWriteLong(PreviousState);
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-            
-        _SEH_END;
+        }
+        _SEH_END;
 
+        /* Bail out if pointer was invalid */
         if(!NT_SUCCESS(Status)) return Status;
     }
-    
+
     /* Open the Object */
     Status = ObReferenceObjectByHandle(EventHandle,
                                        EVENT_MODIFY_STATE,
@@ -276,26 +277,28 @@ NtPulseEvent(IN HANDLE EventHandle,
                                        PreviousMode,
                                        (PVOID*)&Event,
                                        NULL);
-    
+
     /* Check for success */
-    if(NT_SUCCESS(Status)) {
-        
+    if(NT_SUCCESS(Status))
+    {
         /* Pulse the Event */
         LONG Prev = KePulseEvent(Event, EVENT_INCREMENT, FALSE);
         ObDereferenceObject(Event);
-     
-        /* Return it */        
-        if(PreviousState) {
-            
-            _SEH_TRY {
-                
+
+        /* Check if caller wants the old state back */
+        if(PreviousState)
+        {
+            /* Entry SEH Block for return */
+            _SEH_TRY
+            {
+                /* Return previous state */
                 *PreviousState = Prev;
-            
-            } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-                
+            }
+            _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+            {
                 Status = _SEH_GetExceptionCode();
-            
-            _SEH_END;
+            }
+            _SEH_END;
         }
    }
 
@@ -303,12 +306,11 @@ NtPulseEvent(IN HANDLE EventHandle,
    return Status;
 }
 
-
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtQueryEvent(IN HANDLE EventHandle,
              IN EVENT_INFORMATION_CLASS EventInformationClass,
              OUT PVOID EventInformation,
@@ -319,25 +321,24 @@ NtQueryEvent(IN HANDLE EventHandle,
     KPROCESSOR_MODE PreviousMode  = ExGetPreviousMode();
     NTSTATUS Status = STATUS_SUCCESS;
     PEVENT_BASIC_INFORMATION BasicInfo = (PEVENT_BASIC_INFORMATION)EventInformation;
-    
     PAGED_CODE();
-    DPRINT("NtQueryEvent(0x%x, 0x%x, 0x%x)\n", EventHandle, EventInformationClass);
-    
+    DPRINT("NtQueryEvent(0x%p, 0x%x)\n", EventHandle, EventInformationClass);
+
     /* Check buffers and class validity */
-    DefaultQueryInfoBufferCheck(EventInformationClass,
-                                ExEventInfoClass,
-                                EventInformation,
-                                EventInformationLength,
-                                ReturnLength,
-                                PreviousMode,
-                                &Status);
-    if(!NT_SUCCESS(Status)) {
-        
+    Status = DefaultQueryInfoBufferCheck(EventInformationClass,
+                                         ExEventInfoClass,
+                                         sizeof(ExEventInfoClass) / sizeof(ExEventInfoClass[0]),
+                                         EventInformation,
+                                         EventInformationLength,
+                                         ReturnLength,
+                                         PreviousMode);
+    if(!NT_SUCCESS(Status))
+    {
         /* Invalid buffers */
         DPRINT("NtQuerySemaphore() failed, Status: 0x%x\n", Status);
         return Status;
     }
-   
+
     /* Get the Object */
     Status = ObReferenceObjectByHandle(EventHandle,
                                        EVENT_QUERY_STATE,
@@ -345,24 +346,25 @@ NtQueryEvent(IN HANDLE EventHandle,
                                        PreviousMode,
                                        (PVOID*)&Event,
                                        NULL);
-    
-    /* Check for success */
-    if(NT_SUCCESS(Status)) {
 
-        _SEH_TRY {
-            
+    /* Check for success */
+    if(NT_SUCCESS(Status))
+    {
+        /* Entry SEH Block */
+        _SEH_TRY
+        {
             /* Return Event Type and State */
             BasicInfo->EventType = Event->Header.Type;
             BasicInfo->EventState = KeReadStateEvent(Event);
 
             /* Return length */
             if(ReturnLength) *ReturnLength = sizeof(EVENT_BASIC_INFORMATION);
-            
-        } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-            
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-            
-        _SEH_END;
+        }
+        _SEH_END;
 
         /* Dereference the Object */
         ObDereferenceObject(Event);
@@ -375,33 +377,34 @@ NtQueryEvent(IN HANDLE EventHandle,
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtResetEvent(IN HANDLE EventHandle,
              OUT PLONG PreviousState OPTIONAL)
 {
     PKEVENT Event;
     KPROCESSOR_MODE PreviousMode = ExGetPreviousMode();
     NTSTATUS Status = STATUS_SUCCESS;
-   
     PAGED_CODE();
     DPRINT("NtResetEvent(EventHandle 0%x PreviousState 0%x)\n",
             EventHandle, PreviousState);
 
-    /* Check buffer validity */
-    if(PreviousState && PreviousMode == UserMode) {
-        
-        _SEH_TRY {
-            
-            ProbeForWrite(PreviousState,
-                          sizeof(LONG),
-                          sizeof(ULONG));
-         } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-             
+    /* Check if we were called from user-mode */
+    if((PreviousState) && (PreviousMode != KernelMode))
+    {
+        /* Entry SEH Block */
+        _SEH_TRY
+        {
+            /* Make sure the state pointer is valid */
+            ProbeForWriteLong(PreviousState);
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-            
-        _SEH_END;
+        }
+        _SEH_END;
 
+        /* Bail out if pointer was invalid */
         if(!NT_SUCCESS(Status)) return Status;
     }
 
@@ -412,26 +415,28 @@ NtResetEvent(IN HANDLE EventHandle,
                                        PreviousMode,
                                        (PVOID*)&Event,
                                        NULL);
-    
+
     /* Check for success */
-    if(NT_SUCCESS(Status)) {
-        
+    if(NT_SUCCESS(Status))
+    {
         /* Reset the Event */
         LONG Prev = KeResetEvent(Event);
         ObDereferenceObject(Event);
-     
-        /* Return it */        
-        if(PreviousState) {
-            
-            _SEH_TRY {
-                
+
+        /* Check if caller wants the old state back */
+        if(PreviousState)
+        {
+            /* Entry SEH Block for return */
+            _SEH_TRY
+            {
+                /* Return previous state */
                 *PreviousState = Prev;
-            
-            } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-                
+            }
+            _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+            {
                 Status = _SEH_GetExceptionCode();
-            
-            _SEH_END;
+            }
+            _SEH_END;
         }
    }
 
@@ -442,33 +447,34 @@ NtResetEvent(IN HANDLE EventHandle,
 /*
  * @implemented
  */
-NTSTATUS 
-STDCALL
+NTSTATUS
+NTAPI
 NtSetEvent(IN HANDLE EventHandle,
            OUT PLONG PreviousState  OPTIONAL)
 {
     PKEVENT Event;
     KPROCESSOR_MODE PreviousMode = ExGetPreviousMode();
     NTSTATUS Status = STATUS_SUCCESS;
-   
     PAGED_CODE();
     DPRINT("NtSetEvent(EventHandle 0%x PreviousState 0%x)\n",
            EventHandle, PreviousState);
 
-    /* Check buffer validity */
-    if(PreviousState != NULL && PreviousMode == UserMode) {
-        
-        _SEH_TRY {
-            
-            ProbeForWrite(PreviousState,
-                          sizeof(LONG),
-                          sizeof(ULONG));
-         } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-             
+    /* Check if we were called from user-mode */
+    if((PreviousState) && (PreviousMode != KernelMode))
+    {
+        /* Entry SEH Block */
+        _SEH_TRY
+        {
+            /* Make sure the state pointer is valid */
+            ProbeForWriteLong(PreviousState);
+        }
+        _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+        {
             Status = _SEH_GetExceptionCode();
-            
-        _SEH_END;
+        }
+        _SEH_END;
 
+        /* Bail out if pointer was invalid */
         if(!NT_SUCCESS(Status)) return Status;
     }
 
@@ -479,26 +485,28 @@ NtSetEvent(IN HANDLE EventHandle,
                                        PreviousMode,
                                        (PVOID*)&Event,
                                        NULL);
-    
-    /* Check for success */
-    if(NT_SUCCESS(Status)) {
 
+    /* Check for success */
+    if(NT_SUCCESS(Status))
+    {
         /* Set the Event */
         LONG Prev = KeSetEvent(Event, EVENT_INCREMENT, FALSE);
         ObDereferenceObject(Event);
 
-        /* Return it */        
-        if(PreviousState) {
-            
-            _SEH_TRY {
-                
+        /* Check if caller wants the old state back */
+        if(PreviousState)
+        {
+            /* Entry SEH Block for return */
+            _SEH_TRY
+            {
+                /* Return previous state */
                 *PreviousState = Prev;
-            
-            } _SEH_EXCEPT(_SEH_ExSystemExceptionFilter) {
-                
+            }
+            _SEH_EXCEPT(_SEH_ExSystemExceptionFilter)
+            {
                 Status = _SEH_GetExceptionCode();
-            
-            _SEH_END;
+            }
+            _SEH_END;
         }
    }