ReactOS 0.4.15-dev-8145-ga541a46
stackovf.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/fsrtl/stackovf.c
5 * PURPOSE: Provides Stack Overflow support for File System Drivers
6 * PROGRAMMERS: Pierre Schweitzer (pierre@reactos.org)
7 */
8
9/* INCLUDES ******************************************************************/
10
11#include <ntoskrnl.h>
12#define NDEBUG
13#include <debug.h>
14
15/* GLOBALS *******************************************************************/
16
17/* We have one queue for paging files, one queue for normal files
18 * Queue 0 is for non-paging files
19 * Queue 1 is for paging files
20 * Don't add new/change current queues unless you know what you do
21 * Most of the code relies on the fact that we have two queues in that order
22 */
23#define FSRTLP_MAX_QUEUES 2
24
26{
27
33
37
38/* PRIVATE FUNCTIONS *********************************************************/
39
40/*
41 * @implemented
42 */
43VOID
46{
48
50
51 /* Put us as top IRP for current thread */
53 /* And call FsRtlSORoutine */
54 WorkItem->Routine(WorkItem->Context, WorkItem->Event);
55
56 /* If we were using fallback workitem, don't free it, just reset event */
58 {
60 }
61 /* Otherwise, free the work item */
62 else
63 {
65 }
66
67 /* Reset top level */
69}
70
71/*
72 * @implemented
73 */
74VOID
79 IN BOOLEAN IsPaging)
80{
82
83 /* Try to allocate a work item */
85 if (WorkItem == NULL)
86 {
87 /* If we failed, and we are not a paging file, just raise an error */
88 if (!IsPaging)
89 {
91 }
92
93 /* Otherwise, wait for fallback workitem to be available and use it */
96 }
97
98 /* Initialize work item */
100 WorkItem->Event = Event;
103
104 /* And queue it in the appropriate queue (paging or not?) */
105 KeInsertQueue(&FsRtlWorkerQueues[IsPaging], &WorkItem->WorkItem.List);
106}
107
108/*
109 * @implemented
110 */
111VOID
112NTAPI
114{
115 KIRQL Irql;
118 ULONG_PTR QueueId = (ULONG_PTR)StartContext;
119
120 /* Set our priority according to the queue we're dealing with */
122
123 /* Loop for events */
124 for (;;)
125 {
126 /* Look for next event */
129
130 /* Call its routine (here: FsRtlStackOverflowRead) */
131 WorkItem->WorkerRoutine(WorkItem->Parameter);
132
133 /* Check we're still at passive level or bugcheck */
135 if (Irql != PASSIVE_LEVEL)
136 {
137 KeBugCheckEx(IRQL_NOT_LESS_OR_EQUAL, (ULONG_PTR)WorkItem->WorkerRoutine,
138 (ULONG_PTR)Irql, (ULONG_PTR)WorkItem->WorkerRoutine,
140 }
141 }
142}
143
144/*
145 * @implemented
146 */
147CODE_SEG("INIT")
149NTAPI
151{
152 ULONG_PTR i;
154 HANDLE ThreadHandle;
156
157 /* Initialize each queue we have */
158 for (i = 0; i < FSRTLP_MAX_QUEUES; ++i)
159 {
161 NULL,
162 0,
163 NULL,
164 NULL);
165
166 /* Initialize the queue and its associated thread and pass it the queue ID */
169 0, 0, FsRtlWorkerThread, (PVOID)i);
170 if (!NT_SUCCESS(Status))
171 {
172 return Status;
173 }
174
175 /* Don't leak handle */
176 ZwClose(ThreadHandle);
177 }
178
179 /* Also initialize our fallback event, set it to ensure it's already usable */
181
182 return Status;
183}
184
185/* PUBLIC FUNCTIONS **********************************************************/
186
187/*++
188 * @name FsRtlPostPagingFileStackOverflow
189 * @implemented NT 5.2
190 *
191 * The FsRtlPostPagingFileStackOverflow routine
192 *
193 * @param Context
194 *
195 * @param Event
196 *
197 * @param StackOverflowRoutine
198 *
199 * @return
200 *
201 * @remarks None.
202 *
203 *--*/
204VOID
205NTAPI
209{
211}
212
213/*++
214 * @name FsRtlPostStackOverflow
215 * @implemented NT 5.2
216 *
217 * The FsRtlPostStackOverflow routine
218 *
219 * @param Context
220 *
221 * @param Event
222 *
223 * @param StackOverflowRoutine
224 *
225 * @return
226 *
227 * @remarks None.
228 *
229 *--*/
230VOID
231NTAPI
235{
237}
238
239/* EOF */
#define CODE_SEG(...)
unsigned char BOOLEAN
LONG NTSTATUS
Definition: precomp.h:26
IN PUNICODE_STRING IN POBJECT_ATTRIBUTES ObjectAttributes
Definition: conport.c:36
_Out_ PKIRQL Irql
Definition: csq.h:179
#define NULL
Definition: types.h:112
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define NT_SUCCESS(StatCode)
Definition: apphelp.c:32
#define ULONG_PTR
Definition: config.h:101
#define ExAllocatePoolWithTag(hernya, size, tag)
Definition: env_spec_w32.h:350
#define PASSIVE_LEVEL
Definition: env_spec_w32.h:693
UCHAR KIRQL
Definition: env_spec_w32.h:591
#define PsGetCurrentThread()
Definition: env_spec_w32.h:81
#define KeWaitForSingleObject(pEvt, foo, a, b, c)
Definition: env_spec_w32.h:478
#define KeInitializeEvent(pEvt, foo, foo2)
Definition: env_spec_w32.h:477
#define KeSetEvent(pEvt, foo, foo2)
Definition: env_spec_w32.h:476
#define KeGetCurrentIrql()
Definition: env_spec_w32.h:706
#define NonPagedPool
Definition: env_spec_w32.h:307
_In_ PKEVENT _In_ PFSRTL_STACK_OVERFLOW_ROUTINE StackOverflowRoutine
Definition: fsrtlfuncs.h:818
#define FSRTL_FSP_TOP_LEVEL_IRP
Definition: fsrtltypes.h:59
VOID(NTAPI * PFSRTL_STACK_OVERFLOW_ROUTINE)(_In_ PVOID Context, _In_ PKEVENT Event)
Definition: fsrtltypes.h:105
Status
Definition: gdiplustypes.h:25
GLsizei GLenum const GLvoid GLsizei GLenum GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLint GLint GLint GLshort GLshort GLshort GLubyte GLubyte GLubyte GLuint GLuint GLuint GLushort GLushort GLushort GLbyte GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLfloat GLint GLint GLint GLint GLshort GLshort GLshort GLshort GLubyte GLubyte GLubyte GLubyte GLuint GLuint GLuint GLuint GLushort GLushort GLushort GLushort GLboolean const GLdouble const GLfloat const GLint const GLshort const GLbyte const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLdouble const GLfloat const GLfloat const GLint const GLint const GLshort const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort GLenum GLenum GLenum GLfloat GLenum GLint GLenum GLenum GLenum GLfloat GLenum GLenum GLint GLenum GLfloat GLenum GLint GLint GLushort GLenum GLenum GLfloat GLenum GLenum GLint GLfloat const GLubyte GLenum GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLint GLint GLsizei GLsizei GLint GLenum GLenum const GLvoid GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLenum const GLdouble GLenum GLenum const GLfloat GLenum GLenum const GLint GLsizei GLuint GLfloat GLuint GLbitfield GLfloat GLint GLuint GLboolean GLenum GLfloat GLenum GLbitfield GLenum GLfloat GLfloat GLint GLint const GLfloat GLenum GLfloat GLfloat GLint GLint GLfloat GLfloat GLint GLint const GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat const GLdouble const GLfloat const GLdouble const GLfloat GLint i
Definition: glfuncs.h:248
#define LOW_REALTIME_PRIORITY
#define ExFreePoolWithTag(_P, _T)
Definition: module.h:1109
#define InitializeObjectAttributes(p, n, a, r, s)
Definition: reg.c:106
#define KernelMode
Definition: asm.h:34
NTSYSAPI NTSTATUS NTAPI ZwClose(_In_ HANDLE Handle)
DECLSPEC_NORETURN NTSYSAPI VOID NTAPI RtlRaiseStatus(_In_ NTSTATUS Status)
#define THREAD_ALL_ACCESS
Definition: nt_native.h:1339
@ SynchronizationEvent
VOID NTAPI IoSetTopLevelIrp(IN PIRP Irp)
Definition: irp.c:2000
LONG NTAPI KeInsertQueue(IN PKQUEUE Queue, IN PLIST_ENTRY Entry)
Definition: queue.c:198
VOID NTAPI KeInitializeQueue(IN PKQUEUE Queue, IN ULONG Count OPTIONAL)
Definition: queue.c:148
PLIST_ENTRY NTAPI KeRemoveQueue(IN PKQUEUE Queue, IN KPROCESSOR_MODE WaitMode, IN PLARGE_INTEGER Timeout OPTIONAL)
Definition: queue.c:238
NTSTATUS NTAPI PsCreateSystemThread(OUT PHANDLE ThreadHandle, IN ACCESS_MASK DesiredAccess, IN POBJECT_ATTRIBUTES ObjectAttributes, IN HANDLE ProcessHandle, IN PCLIENT_ID ClientId, IN PKSTART_ROUTINE StartRoutine, IN PVOID StartContext)
Definition: thread.c:602
VOID NTAPI KeBugCheckEx(_In_ ULONG BugCheckCode, _In_ ULONG_PTR BugCheckParameter1, _In_ ULONG_PTR BugCheckParameter2, _In_ ULONG_PTR BugCheckParameter3, _In_ ULONG_PTR BugCheckParameter4)
Definition: rtlcompat.c:108
VOID NTAPI FsRtlWorkerThread(IN PVOID StartContext)
Definition: stackovf.c:113
STACK_OVERFLOW_WORK_ITEM StackOverflowFallback
Definition: stackovf.c:35
KQUEUE FsRtlWorkerQueues[FSRTLP_MAX_QUEUES]
Definition: stackovf.c:36
VOID NTAPI FsRtlpPostStackOverflow(IN PVOID Context, IN PKEVENT Event, IN PFSRTL_STACK_OVERFLOW_ROUTINE StackOverflowRoutine, IN BOOLEAN IsPaging)
Definition: stackovf.c:76
#define FSRTLP_MAX_QUEUES
Definition: stackovf.c:23
struct _STACK_OVERFLOW_WORK_ITEM STACK_OVERFLOW_WORK_ITEM
NTSTATUS NTAPI FsRtlInitializeWorkerThread(VOID)
Definition: stackovf.c:150
VOID NTAPI FsRtlPostStackOverflow(IN PVOID Context, IN PKEVENT Event, IN PFSRTL_STACK_OVERFLOW_ROUTINE StackOverflowRoutine)
Definition: stackovf.c:232
KEVENT StackOverflowFallbackSerialEvent
Definition: stackovf.c:34
struct _STACK_OVERFLOW_WORK_ITEM * PSTACK_OVERFLOW_WORK_ITEM
VOID NTAPI FsRtlStackOverflowRead(IN PVOID Context)
Definition: stackovf.c:45
VOID NTAPI FsRtlPostPagingFileStackOverflow(IN PVOID Context, IN PKEVENT Event, IN PFSRTL_STACK_OVERFLOW_ROUTINE StackOverflowRoutine)
Definition: stackovf.c:206
base of all file and directory entries
Definition: entries.h:83
Definition: typedefs.h:120
WORK_QUEUE_ITEM WorkItem
Definition: stackovf.c:28
PFSRTL_STACK_OVERFLOW_ROUTINE Routine
Definition: stackovf.c:29
KPRIORITY NTAPI KeSetPriorityThread(IN PKTHREAD Thread, IN KPRIORITY Priority)
Definition: thrdobj.c:1319
#define NTAPI
Definition: typedefs.h:36
uint32_t ULONG_PTR
Definition: typedefs.h:65
#define IN
Definition: typedefs.h:39
#define CONTAINING_RECORD(address, type, field)
Definition: typedefs.h:260
#define STATUS_INSUFFICIENT_RESOURCES
Definition: udferr_usr.h:158
_Must_inspect_result_ _In_ WDFCMRESLIST List
Definition: wdfresource.h:550
_Must_inspect_result_ _In_ PWDF_WORKITEM_CONFIG _In_ PWDF_OBJECT_ATTRIBUTES _Out_ WDFWORKITEM * WorkItem
Definition: wdfworkitem.h:115
#define ExInitializeWorkItem(Item, Routine, Context)
Definition: exfuncs.h:265
@ Executive
Definition: ketypes.h:415