ReactOS 0.4.15-dev-8138-g1e75ea8
filtrctx.c File Reference
#include <ntoskrnl.h>
#include <debug.h>
Include dependency graph for filtrctx.c:

Go to the source code of this file.

Classes

struct  _FILE_OBJECT_FILTER_CONTEXTS
 

Macros

#define NDEBUG
 

Typedefs

typedef struct _FILE_OBJECT_FILTER_CONTEXTS FILE_OBJECT_FILTER_CONTEXTS
 
typedef struct _FILE_OBJECT_FILTER_CONTEXTSPFILE_OBJECT_FILTER_CONTEXTS
 

Functions

VOID NTAPI FsRtlPTeardownPerFileObjectContexts (IN PFILE_OBJECT FileObject)
 
LOGICAL NTAPI FsRtlIsPagingFile (IN PFILE_OBJECT FileObject)
 
PFSRTL_PER_FILEOBJECT_CONTEXT NTAPI FsRtlLookupPerFileObjectContext (IN PFILE_OBJECT FileObject, IN PVOID OwnerId OPTIONAL, IN PVOID InstanceId OPTIONAL)
 
PFSRTL_PER_STREAM_CONTEXT NTAPI FsRtlLookupPerStreamContextInternal (IN PFSRTL_ADVANCED_FCB_HEADER AdvFcbHeader, IN PVOID OwnerId OPTIONAL, IN PVOID InstanceId OPTIONAL)
 
NTSTATUS NTAPI FsRtlInsertPerFileObjectContext (IN PFILE_OBJECT FileObject, IN PFSRTL_PER_FILEOBJECT_CONTEXT Ptr)
 
NTSTATUS NTAPI FsRtlInsertPerStreamContext (IN PFSRTL_ADVANCED_FCB_HEADER AdvFcbHeader, IN PFSRTL_PER_STREAM_CONTEXT PerStreamContext)
 
PFSRTL_PER_FILEOBJECT_CONTEXT NTAPI FsRtlRemovePerFileObjectContext (IN PFILE_OBJECT FileObject, IN PVOID OwnerId OPTIONAL, IN PVOID InstanceId OPTIONAL)
 
PFSRTL_PER_STREAM_CONTEXT NTAPI FsRtlRemovePerStreamContext (IN PFSRTL_ADVANCED_FCB_HEADER AdvFcbHeader, IN PVOID OwnerId OPTIONAL, IN PVOID InstanceId OPTIONAL)
 
VOID NTAPI FsRtlTeardownPerStreamContexts (IN PFSRTL_ADVANCED_FCB_HEADER AdvFcbHeader)
 

Macro Definition Documentation

◆ NDEBUG

#define NDEBUG

Definition at line 12 of file filtrctx.c.

Typedef Documentation

◆ FILE_OBJECT_FILTER_CONTEXTS

◆ PFILE_OBJECT_FILTER_CONTEXTS

Function Documentation

◆ FsRtlInsertPerFileObjectContext()

NTSTATUS NTAPI FsRtlInsertPerFileObjectContext ( IN PFILE_OBJECT  FileObject,
IN PFSRTL_PER_FILEOBJECT_CONTEXT  Ptr 
)

Definition at line 175 of file filtrctx.c.

177{
179
180 if (!FileObject)
181 {
183 }
184
186 {
188 }
189
190 /* Get filter contexts */
192 if (!FOContext)
193 {
194 /* If there's none, allocate new structure */
196 if (!FOContext)
197 {
199 }
200
201 /* Initialize it */
203 InitializeListHead(&(FOContext->FilterContexts));
204
205 /* Set it */
207 {
208 /* If it fails, it means that someone else has set it in the meanwhile */
209 ExFreePoolWithTag(FOContext, 'FOCX');
210
211 /* So, we can get it */
213 if (!FOContext)
214 {
215 /* If we fall down here, something went very bad. This shouldn't happen */
216 ASSERT(FALSE);
217 return STATUS_UNSUCCESSFUL;
218 }
219 }
220 }
221
222 /* Finally, insert */
224 InsertHeadList(&(FOContext->FilterContexts), &(Ptr->Links));
226
227 return STATUS_SUCCESS;
228}
#define NULL
Definition: types.h:112
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define InsertHeadList(ListHead, Entry)
#define ExAllocatePoolWithTag(hernya, size, tag)
Definition: env_spec_w32.h:350
#define NonPagedPool
Definition: env_spec_w32.h:307
#define InitializeListHead(ListHead)
Definition: env_spec_w32.h:944
_Must_inspect_result_ _In_ PFSRTL_PER_STREAM_CONTEXT Ptr
Definition: fsrtlfuncs.h:898
VOID FASTCALL ExAcquireFastMutex(IN PFAST_MUTEX FastMutex)
Definition: fmutex.c:23
VOID FASTCALL ExReleaseFastMutex(IN PFAST_MUTEX FastMutex)
Definition: fmutex.c:31
#define ASSERT(a)
Definition: mode.c:44
#define ExFreePoolWithTag(_P, _T)
Definition: module.h:1109
#define FO_FILE_OBJECT_HAS_EXTENSION
Definition: iotypes.h:144
NTSTATUS NTAPI IoChangeFileObjectFilterContext(IN PFILE_OBJECT FileObject, IN PVOID FilterContext, IN BOOLEAN Define)
Definition: file.c:2511
PVOID NTAPI IoGetFileObjectFilterContext(IN PFILE_OBJECT FileObject)
Definition: file.c:2496
#define STATUS_SUCCESS
Definition: shellext.h:65
FAST_MUTEX FilterContextsMutex
Definition: filtrctx.c:19
#define STATUS_INVALID_DEVICE_REQUEST
Definition: udferr_usr.h:138
#define STATUS_INVALID_PARAMETER
Definition: udferr_usr.h:135
#define STATUS_UNSUCCESSFUL
Definition: udferr_usr.h:132
#define STATUS_INSUFFICIENT_RESOURCES
Definition: udferr_usr.h:158
_In_ WDFREQUEST _In_ WDFFILEOBJECT FileObject
Definition: wdfdevice.h:550
FORCEINLINE VOID ExInitializeFastMutex(_Out_ PFAST_MUTEX FastMutex)
Definition: exfuncs.h:274

◆ FsRtlInsertPerStreamContext()

NTSTATUS NTAPI FsRtlInsertPerStreamContext ( IN PFSRTL_ADVANCED_FCB_HEADER  AdvFcbHeader,
IN PFSRTL_PER_STREAM_CONTEXT  PerStreamContext 
)

Definition at line 235 of file filtrctx.c.

237{
238 if (!(AdvFcbHeader) || !(AdvFcbHeader->Flags2 & FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS))
239 {
241 }
242
243 ExAcquireFastMutex(AdvFcbHeader->FastMutex);
244 InsertHeadList(&(AdvFcbHeader->FilterContexts), &(PerStreamContext->Links));
245 ExReleaseFastMutex(AdvFcbHeader->FastMutex);
246 return STATUS_SUCCESS;
247}
#define FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS
Definition: fsrtltypes.h:55

◆ FsRtlIsPagingFile()

LOGICAL NTAPI FsRtlIsPagingFile ( IN PFILE_OBJECT  FileObject)

Definition at line 64 of file filtrctx.c.

65{
67}
BOOLEAN NTAPI MmIsFileObjectAPagingFile(PFILE_OBJECT FileObject)
Definition: pagefile.c:119

◆ FsRtlLookupPerFileObjectContext()

PFSRTL_PER_FILEOBJECT_CONTEXT NTAPI FsRtlLookupPerFileObjectContext ( IN PFILE_OBJECT  FileObject,
IN PVOID OwnerId  OPTIONAL,
IN PVOID InstanceId  OPTIONAL 
)

Definition at line 74 of file filtrctx.c.

77{
78 PLIST_ENTRY NextEntry;
80 PFSRTL_PER_FILEOBJECT_CONTEXT TmpPerFOContext, PerFOContext = NULL;
81
83 {
84 return NULL;
85 }
86
88
89 /* If list is empty, no need to browse it */
90 if (!IsListEmpty(&(FOContext->FilterContexts)))
91 {
92 for (NextEntry = FOContext->FilterContexts.Flink;
93 NextEntry != &(FOContext->FilterContexts);
94 NextEntry = NextEntry->Flink)
95 {
96 /* If we don't have any criteria for search, first entry will be enough */
97 if (!OwnerId && !InstanceId)
98 {
99 PerFOContext = (PFSRTL_PER_FILEOBJECT_CONTEXT)NextEntry;
100 break;
101 }
102 /* Else, we've to find something that matches with the parameters. */
103 else
104 {
105 TmpPerFOContext = CONTAINING_RECORD(NextEntry, FSRTL_PER_FILEOBJECT_CONTEXT, Links);
106 if ((InstanceId && TmpPerFOContext->InstanceId == InstanceId && TmpPerFOContext->OwnerId == OwnerId) ||
107 (OwnerId && TmpPerFOContext->OwnerId == OwnerId))
108 {
109 PerFOContext = TmpPerFOContext;
110 break;
111 }
112 }
113 }
114 }
115
117
118 return PerFOContext;
119}
#define IsListEmpty(ListHead)
Definition: env_spec_w32.h:954
_Must_inspect_result_ _In_opt_ PVOID _In_opt_ PVOID InstanceId
Definition: fsrtlfuncs.h:908
_Must_inspect_result_ _In_opt_ PVOID OwnerId
Definition: fsrtlfuncs.h:907
struct _FSRTL_PER_FILEOBJECT_CONTEXT * PFSRTL_PER_FILEOBJECT_CONTEXT
Definition: typedefs.h:120
struct _LIST_ENTRY * Flink
Definition: typedefs.h:121
#define CONTAINING_RECORD(address, type, field)
Definition: typedefs.h:260

◆ FsRtlLookupPerStreamContextInternal()

PFSRTL_PER_STREAM_CONTEXT NTAPI FsRtlLookupPerStreamContextInternal ( IN PFSRTL_ADVANCED_FCB_HEADER  AdvFcbHeader,
IN PVOID OwnerId  OPTIONAL,
IN PVOID InstanceId  OPTIONAL 
)

Definition at line 126 of file filtrctx.c.

129{
130 PLIST_ENTRY NextEntry;
131 PFSRTL_PER_STREAM_CONTEXT TmpPerStreamContext, PerStreamContext = NULL;
132
133 ASSERT(AdvFcbHeader);
134 ASSERT(FlagOn(AdvFcbHeader->Flags2, FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS));
135
136 ExAcquireFastMutex(AdvFcbHeader->FastMutex);
137
138 /* If list is empty, no need to browse it */
139 if (!IsListEmpty(&(AdvFcbHeader->FilterContexts)))
140 {
141 for (NextEntry = AdvFcbHeader->FilterContexts.Flink;
142 NextEntry != &(AdvFcbHeader->FilterContexts);
143 NextEntry = NextEntry->Flink)
144 {
145 /* If we don't have any criteria for search, first entry will be enough */
146 if (!OwnerId && !InstanceId)
147 {
148 PerStreamContext = (PFSRTL_PER_STREAM_CONTEXT)NextEntry;
149 break;
150 }
151 /* Else, we've to find something that matches with the parameters. */
152 else
153 {
154 TmpPerStreamContext = CONTAINING_RECORD(NextEntry, FSRTL_PER_STREAM_CONTEXT, Links);
155 if ((InstanceId && TmpPerStreamContext->InstanceId == InstanceId && TmpPerStreamContext->OwnerId == OwnerId) ||
156 (OwnerId && TmpPerStreamContext->OwnerId == OwnerId))
157 {
158 PerStreamContext = TmpPerStreamContext;
159 break;
160 }
161 }
162 }
163 }
164
165 ExReleaseFastMutex(AdvFcbHeader->FastMutex);
166
167 return PerStreamContext;
168}
#define FlagOn(_F, _SF)
Definition: ext2fs.h:179
struct _FSRTL_PER_STREAM_CONTEXT * PFSRTL_PER_STREAM_CONTEXT

◆ FsRtlPTeardownPerFileObjectContexts()

VOID NTAPI FsRtlPTeardownPerFileObjectContexts ( IN PFILE_OBJECT  FileObject)

Definition at line 28 of file filtrctx.c.

29{
31
33
34 if (!(FOContext = IoGetFileObjectFilterContext(FileObject)))
35 {
36 return;
37 }
38
40 ASSERT(IsListEmpty(&(FOContext->FilterContexts)));
41
42 ExFreePoolWithTag(FOContext, 'FOCX');
43}

Referenced by IopDeleteFile().

◆ FsRtlRemovePerFileObjectContext()

PFSRTL_PER_FILEOBJECT_CONTEXT NTAPI FsRtlRemovePerFileObjectContext ( IN PFILE_OBJECT  FileObject,
IN PVOID OwnerId  OPTIONAL,
IN PVOID InstanceId  OPTIONAL 
)

Definition at line 254 of file filtrctx.c.

257{
258 PLIST_ENTRY NextEntry;
260 PFSRTL_PER_FILEOBJECT_CONTEXT TmpPerFOContext, PerFOContext = NULL;
261
262 if (!FileObject || !(FOContext = IoGetFileObjectFilterContext(FileObject)))
263 {
264 return NULL;
265 }
266
268
269 /* If list is empty, no need to browse it */
270 if (!IsListEmpty(&(FOContext->FilterContexts)))
271 {
272 for (NextEntry = FOContext->FilterContexts.Flink;
273 NextEntry != &(FOContext->FilterContexts);
274 NextEntry = NextEntry->Flink)
275 {
276 /* If we don't have any criteria for search, first entry will be enough */
277 if (!OwnerId && !InstanceId)
278 {
279 PerFOContext = (PFSRTL_PER_FILEOBJECT_CONTEXT)NextEntry;
280 break;
281 }
282 /* Else, we've to find something that matches with the parameters. */
283 else
284 {
285 TmpPerFOContext = CONTAINING_RECORD(NextEntry, FSRTL_PER_FILEOBJECT_CONTEXT, Links);
286 if ((InstanceId && TmpPerFOContext->InstanceId == InstanceId && TmpPerFOContext->OwnerId == OwnerId) ||
287 (OwnerId && TmpPerFOContext->OwnerId == OwnerId))
288 {
289 PerFOContext = TmpPerFOContext;
290 break;
291 }
292 }
293 }
294
295 /* Finally remove entry from list */
296 if (PerFOContext)
297 {
298 RemoveEntryList(&(PerFOContext->Links));
299 }
300 }
301
303
304 return PerFOContext;
305}
#define RemoveEntryList(Entry)
Definition: env_spec_w32.h:986

◆ FsRtlRemovePerStreamContext()

PFSRTL_PER_STREAM_CONTEXT NTAPI FsRtlRemovePerStreamContext ( IN PFSRTL_ADVANCED_FCB_HEADER  AdvFcbHeader,
IN PVOID OwnerId  OPTIONAL,
IN PVOID InstanceId  OPTIONAL 
)

Definition at line 312 of file filtrctx.c.

315{
316 PLIST_ENTRY NextEntry;
317 PFSRTL_PER_STREAM_CONTEXT TmpPerStreamContext, PerStreamContext = NULL;
318
319 if (!(AdvFcbHeader) || !(AdvFcbHeader->Flags2 & FSRTL_FLAG2_SUPPORTS_FILTER_CONTEXTS))
320 {
321 return NULL;
322 }
323
324 ExAcquireFastMutex(AdvFcbHeader->FastMutex);
325 /* If list is empty, no need to browse it */
326 if (!IsListEmpty(&(AdvFcbHeader->FilterContexts)))
327 {
328 for (NextEntry = AdvFcbHeader->FilterContexts.Flink;
329 NextEntry != &(AdvFcbHeader->FilterContexts);
330 NextEntry = NextEntry->Flink)
331 {
332 /* If we don't have any criteria for search, first entry will be enough */
333 if (!OwnerId && !InstanceId)
334 {
335 PerStreamContext = (PFSRTL_PER_STREAM_CONTEXT)NextEntry;
336 break;
337 }
338 /* Else, we've to find something that matches with the parameters. */
339 else
340 {
341 TmpPerStreamContext = CONTAINING_RECORD(NextEntry, FSRTL_PER_STREAM_CONTEXT, Links);
342 if ((InstanceId && TmpPerStreamContext->InstanceId == InstanceId && TmpPerStreamContext->OwnerId == OwnerId) ||
343 (OwnerId && TmpPerStreamContext->OwnerId == OwnerId))
344 {
345 PerStreamContext = TmpPerStreamContext;
346 break;
347 }
348 }
349 }
350
351 /* Finally remove entry from list */
352 if (PerStreamContext)
353 {
354 RemoveEntryList(&(PerStreamContext->Links));
355 }
356 }
357 ExReleaseFastMutex(AdvFcbHeader->FastMutex);
358
359 return PerStreamContext;
360
361}

◆ FsRtlTeardownPerStreamContexts()

VOID NTAPI FsRtlTeardownPerStreamContexts ( IN PFSRTL_ADVANCED_FCB_HEADER  AdvFcbHeader)

Definition at line 368 of file filtrctx.c.

369{
370 PLIST_ENTRY NextEntry;
371 volatile BOOLEAN IsMutexLocked = FALSE;
372 PFSRTL_PER_STREAM_CONTEXT PerStreamContext;
373
375 {
376 /* Acquire mutex to deal with the list */
377 ExAcquireFastMutex(AdvFcbHeader->FastMutex);
378 IsMutexLocked = TRUE;
379
380 /* While there are items... */
381 while (!IsListEmpty(&(AdvFcbHeader->FilterContexts)))
382 {
383 /* ...remove one */
384 NextEntry = RemoveHeadList(&(AdvFcbHeader->FilterContexts));
385 PerStreamContext = CONTAINING_RECORD(NextEntry, FSRTL_PER_STREAM_CONTEXT, Links);
386
387 /* Release mutex before calling callback */
388 ExReleaseFastMutex(AdvFcbHeader->FastMutex);
389 IsMutexLocked = FALSE;
390
391 /* Call the callback */
392 ASSERT(PerStreamContext->FreeCallback);
393 (*PerStreamContext->FreeCallback)(PerStreamContext);
394
395 /* Relock the list to continue */
396 ExAcquireFastMutex(AdvFcbHeader->FastMutex);
397 IsMutexLocked = TRUE;
398 }
399 }
401 {
402 /* If mutex was locked, release */
403 if (IsMutexLocked)
404 {
405 ExReleaseFastMutex(AdvFcbHeader->FastMutex);
406 }
407 }
408 _SEH2_END;
409}
unsigned char BOOLEAN
#define RemoveHeadList(ListHead)
Definition: env_spec_w32.h:964
#define _SEH2_FINALLY
Definition: filesup.c:21
#define _SEH2_END
Definition: filesup.c:22
#define _SEH2_TRY
Definition: filesup.c:19
PFREE_FUNCTION FreeCallback
Definition: fsrtltypes.h:164

Referenced by CdDeleteFcb(), Ext2FreeFcb(), FatDeleteFcb(), FatTearDownVcb(), and RxFreeFcbObject().