ReactOS 0.4.15-dev-8339-g4028de8
controller.c
Go to the documentation of this file.
1/*
2 * PROJECT: ReactOS Kernel
3 * LICENSE: GPL - See COPYING in the top level directory
4 * FILE: ntoskrnl/io/iomgr/controller.c
5 * PURPOSE: I/O Wrappers (called Controllers) for Kernel Device Queues
6 * PROGRAMMERS: Alex Ionescu (alex.ionescu@reactos.org)
7 */
8
9/* INCLUDES *****************************************************************/
10
11#include <ntoskrnl.h>
12#include <debug.h>
13
14/* GLOBALS *******************************************************************/
15
17
18/* FUNCTIONS *****************************************************************/
19
20/*
21 * @implemented
22 */
23VOID
29{
32
33 /* Initialize the Wait Context Block */
34 DeviceObject->Queue.Wcb.DeviceContext = Context;
35 DeviceObject->Queue.Wcb.DeviceRoutine = ExecutionRoutine;
36
37 /* Insert the Device Queue */
38 if (!KeInsertDeviceQueue(&ControllerObject->DeviceWaitQueue,
39 &DeviceObject->Queue.Wcb.WaitQueueEntry))
40 {
41 /* Call the execution routine */
43 DeviceObject->CurrentIrp,
44 NULL,
45 Context);
46
47 /* Free the controller if this was requested */
48 if (Result == DeallocateObject) IoFreeController(ControllerObject);
49 }
50}
51
52/*
53 * @implemented
54 */
58{
59 PCONTROLLER_OBJECT Controller;
63 PAGED_CODE();
64
65 /* Initialize an empty OBA */
67 NULL,
69 NULL,
70 NULL);
71
72 /* Create the Object */
77 NULL,
78 sizeof(CONTROLLER_OBJECT) + Size,
79 0,
80 0,
81 (PVOID*)&Controller);
82 if (!NT_SUCCESS(Status)) return NULL;
83
84 /* Insert it */
85 Status = ObInsertObject(Controller,
86 NULL,
88 1,
89 (PVOID*)&Controller,
90 &Handle);
91 if (!NT_SUCCESS(Status)) return NULL;
92
93 /* Close the dummy handle */
95
96 /* Zero the Object and set its data */
97 RtlZeroMemory(Controller, sizeof(CONTROLLER_OBJECT) + Size);
98 Controller->Type = IO_TYPE_CONTROLLER;
99 Controller->Size = sizeof(CONTROLLER_OBJECT) + (CSHORT)Size;
100 Controller->ControllerExtension = (Controller + 1);
101
102 /* Initialize its Queue */
104
105 /* Return Controller */
106 return Controller;
107}
108
109/*
110 * @implemented
111 */
112VOID
113NTAPI
115{
116 /* Just Dereference it */
117 ObDereferenceObject(ControllerObject);
118}
119
120/*
121 * @implemented
122 */
123VOID
124NTAPI
126{
127 PKDEVICE_QUEUE_ENTRY QueueEntry;
130
131 /* Remove the Queue */
132 QueueEntry = KeRemoveDeviceQueue(&ControllerObject->DeviceWaitQueue);
133 if (QueueEntry)
134 {
135 /* Get the Device Object */
136 DeviceObject = CONTAINING_RECORD(QueueEntry,
138 Queue.Wcb.WaitQueueEntry);
139
140 /* Call the routine */
141 Result = DeviceObject->Queue.Wcb.DeviceRoutine(DeviceObject,
142 DeviceObject->CurrentIrp,
143 NULL,
145 Queue.Wcb.DeviceContext);
146 /* Free the controller if this was requested */
147 if (Result == DeallocateObject) IoFreeController(ControllerObject);
148 }
149}
150
151/* EOF */
#define PAGED_CODE()
LONG NTSTATUS
Definition: precomp.h:26
IN PUNICODE_STRING IN POBJECT_ATTRIBUTES ObjectAttributes
Definition: conport.c:36
VOID NTAPI IoDeleteController(IN PCONTROLLER_OBJECT ControllerObject)
Definition: controller.c:114
POBJECT_TYPE IoControllerObjectType
Definition: controller.c:16
VOID NTAPI IoFreeController(IN PCONTROLLER_OBJECT ControllerObject)
Definition: controller.c:125
VOID NTAPI IoAllocateController(IN PCONTROLLER_OBJECT ControllerObject, IN PDEVICE_OBJECT DeviceObject, IN PDRIVER_CONTROL ExecutionRoutine, IN PVOID Context)
Definition: controller.c:25
PCONTROLLER_OBJECT NTAPI IoCreateController(IN ULONG Size)
Definition: controller.c:57
PKDEVICE_QUEUE_ENTRY NTAPI KeRemoveDeviceQueue(IN PKDEVICE_QUEUE DeviceQueue)
Definition: devqueue.c:153
BOOLEAN NTAPI KeInsertDeviceQueue(IN PKDEVICE_QUEUE DeviceQueue, IN PKDEVICE_QUEUE_ENTRY DeviceQueueEntry)
Definition: devqueue.c:41
VOID NTAPI KeInitializeDeviceQueue(IN PKDEVICE_QUEUE DeviceQueue)
Definition: devqueue.c:22
#define NULL
Definition: types.h:112
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:33
#define ASSERT_IRQL_EQUAL(x)
Definition: debug.h:43
#define DISPATCH_LEVEL
Definition: env_spec_w32.h:696
ULONG Handle
Definition: gdb_input.c:15
Status
Definition: gdiplustypes.h:25
#define OBJ_KERNEL_HANDLE
Definition: winternl.h:231
#define InitializeObjectAttributes(p, n, a, r, s)
Definition: reg.c:106
#define KernelMode
Definition: asm.h:34
#define FILE_WRITE_DATA
Definition: nt_native.h:631
#define FILE_READ_DATA
Definition: nt_native.h:628
NTSTATUS NTAPI ObCloseHandle(IN HANDLE Handle, IN KPROCESSOR_MODE AccessMode)
Definition: obhandle.c:3379
NTSTATUS NTAPI ObInsertObject(IN PVOID Object, IN PACCESS_STATE AccessState OPTIONAL, IN ACCESS_MASK DesiredAccess, IN ULONG ObjectPointerBias, OUT PVOID *NewObject OPTIONAL, OUT PHANDLE Handle)
Definition: obhandle.c:2935
NTSTATUS NTAPI ObCreateObject(IN KPROCESSOR_MODE ProbeMode OPTIONAL, IN POBJECT_TYPE Type, IN POBJECT_ATTRIBUTES ObjectAttributes OPTIONAL, IN KPROCESSOR_MODE AccessMode, IN OUT PVOID ParseContext OPTIONAL, IN ULONG ObjectSize, IN ULONG PagedPoolCharge OPTIONAL, IN ULONG NonPagedPoolCharge OPTIONAL, OUT PVOID *Object)
Definition: oblife.c:1039
KDEVICE_QUEUE DeviceWaitQueue
Definition: iotypes.h:4464
PVOID ControllerExtension
Definition: iotypes.h:4463
Definition: ketypes.h:578
#define NTAPI
Definition: typedefs.h:36
#define RtlZeroMemory(Destination, Length)
Definition: typedefs.h:262
#define IN
Definition: typedefs.h:39
#define CONTAINING_RECORD(address, type, field)
Definition: typedefs.h:260
uint32_t ULONG
Definition: typedefs.h:59
short CSHORT
Definition: umtypes.h:127
_In_ PDEVICE_OBJECT DeviceObject
Definition: wdfdevice.h:2055
_Must_inspect_result_ _In_ WDFDEVICE _In_ PIRP _In_ WDFQUEUE Queue
Definition: wdfdevice.h:2225
_Must_inspect_result_ _In_ WDFDEVICE _In_ PWDF_DEVICE_PROPERTY_DATA _In_ DEVPROPTYPE _In_ ULONG Size
Definition: wdfdevice.h:4533
_At_(*)(_In_ PWSK_CLIENT Client, _In_opt_ PUNICODE_STRING NodeName, _In_opt_ PUNICODE_STRING ServiceName, _In_opt_ ULONG NameSpace, _In_opt_ GUID *Provider, _In_opt_ PADDRINFOEXW Hints, _Outptr_ PADDRINFOEXW *Result, _In_opt_ PEPROCESS OwningProcess, _In_opt_ PETHREAD OwningThread, _Inout_ PIRP Irp Result)(Mem)) NTSTATUS(WSKAPI *PFN_WSK_GET_ADDRESS_INFO
Definition: wsk.h:409
_In_ PDEVICE_OBJECT _In_ ULONG _In_ PDRIVER_CONTROL ExecutionRoutine
Definition: iofuncs.h:1399
enum _IO_ALLOCATION_ACTION IO_ALLOCATION_ACTION
@ DeallocateObject
Definition: iotypes.h:203
DRIVER_CONTROL * PDRIVER_CONTROL
Definition: iotypes.h:215
struct _CONTROLLER_OBJECT CONTROLLER_OBJECT
#define IO_TYPE_CONTROLLER
#define ObDereferenceObject
Definition: obfuncs.h:203