ReactOS 0.4.15-dev-8116-gf69e256
cleanup.c
Go to the documentation of this file.
1/*++
2
3Copyright (c) 1989-2000 Microsoft Corporation
4
5Module Name:
6
7 Cleanup.c
8
9Abstract:
10
11 This module implements the File Cleanup routine for Cdfs called by the
12 dispatch driver.
13
14
15--*/
16
17#include "cdprocs.h"
18
19//
20// The Bug check file id for this module
21//
22
23#define BugCheckFileId (CDFS_BUG_CHECK_CLEANUP)
24
25_Requires_lock_held_(_Global_critical_region_)
27CdCommonCleanup (
28 _Inout_ PIRP_CONTEXT IrpContext,
30 )
31
32/*++
33
34Routine Description:
35
36 This is the common routine for cleanup of a file/directory called by both
37 the fsd and fsp threads.
38
39 Cleanup is invoked whenever the last handle to a file object is closed.
40 This is different than the Close operation which is invoked when the last
41 reference to a file object is deleted.
42
43 The function of cleanup is to essentially "cleanup" the file/directory
44 after a user is done with it. The Fcb/Dcb remains around (because MM
45 still has the file object referenced) but is now available for another
46 user to open (i.e., as far as the user is concerned the is now closed).
47
48 See close for a more complete description of what close does.
49
50 We do no synchronization in this routine until we get to the point
51 where we modify the counts, share access and volume lock field.
52
53 We need to update the Fcb and Vcb to show that a user handle has been closed.
54 The following structures and fields are affected.
55
56 Vcb:
57
58 VolumeLockFileObject - Did the user lock the volume with this file object.
59 VcbState - Check if we are unlocking the volume here.
60 VcbCleanup - Count of outstanding handles on the volume.
61 DirNotifyQueue - If this file object has pending DirNotify Irps.
62
63 Fcb:
64
65 ShareAccess - If this is a user handle.
66 FcbCleanup - Count of outstanding handles on this Fcb.
67 Oplock - Any outstanding oplocks on this file object.
68 FileLock - Any outstanding filelocks on this file object.
69
70Arguments:
71
72 Irp - Supplies the Irp to process
73
74Return Value:
75
76 NTSTATUS - The return status for the operation.
77
78--*/
79
80{
83
84 BOOLEAN SendUnlockNotification = FALSE;
85 BOOLEAN AttemptTeardown = FALSE;
86 BOOLEAN VcbAcquired = FALSE;
87
88 PVCB Vcb;
89 PFCB Fcb;
90 PCCB Ccb;
91
92 KIRQL SavedIrql;
93
94 ASSERT_IRP_CONTEXT( IrpContext );
95 ASSERT_IRP( Irp );
96
97 //
98 // If we were called with our file system device object instead of a
99 // volume device object, just complete this request with STATUS_SUCCESS.
100 //
101
102 if (IrpContext->Vcb == NULL) {
103
104 CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
105 return STATUS_SUCCESS;
106 }
107
108 //
109 // Get the file object out of the Irp and decode the type of open.
110 //
111
113
114 TypeOfOpen = CdDecodeFileObject( IrpContext,
116 &Fcb,
117 &Ccb );
118
119 //
120 // No work here for either an UnopenedFile object or a StreamFileObject.
121 //
122
123 if (TypeOfOpen <= StreamFileOpen) {
124
125 CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
126
127 return STATUS_SUCCESS;
128 }
129
130 //
131 // Keep a local pointer to the Vcb.
132 //
133
134 Vcb = Fcb->Vcb;
135
136 //
137 // Synchronise with reads while we set the cleanup complete
138 // flag on this fileobject. Once this flag is set, any further
139 // reads will be rejected (CdVerifyFcbOperation)
140 //
141
142 CdAcquireFileExclusive( IrpContext, Fcb);
143
144 //
145 // Set the flag in the FileObject to indicate that cleanup is complete.
146 //
147
149
150 CdReleaseFile( IrpContext, Fcb);
151
152 if (TypeOfOpen == UserVolumeOpen) {
153
154 //
155 // For a force dismount, physically disconnect this Vcb from the device so
156 // a new mount can occur. Vcb deletion cannot happen at this time since
157 // there is a reference on it associated with this very request, but we'll
158 // call check for dismount again later after we process this close.
159 //
160
162
163 CdAcquireCdData( IrpContext );
164
165 CdCheckForDismount( IrpContext, Vcb, TRUE );
166
167 CdReleaseCdData( IrpContext );
168
169 //
170 // If this handle actually wrote something, flush the device buffers,
171 // and then set the verify bit now just to be safe (in case there is no
172 // dismount).
173 //
174
175 } else if (FlagOn( FileObject->Flags, FO_FILE_MODIFIED )) {
176
177 CdHijackIrpAndFlushDevice( IrpContext, Irp, Vcb->TargetDeviceObject );
178
180 }
181 }
182
183 //
184 // Acquire the current file.
185 //
186
187 CdAcquireFcbExclusive( IrpContext, Fcb, FALSE );
188
189 //
190 // Use a try-finally to facilitate cleanup.
191 //
192
193 _SEH2_TRY {
194
195 //
196 // Case on the type of open that we are trying to cleanup.
197 //
198
199 switch (TypeOfOpen) {
200
202
203 //
204 // Check if we need to complete any dir notify Irps on this file object.
205 //
206
207 FsRtlNotifyCleanup( Vcb->NotifySync,
208 &Vcb->DirNotifyList,
209 Ccb );
210
211 break;
212
213 case UserFileOpen:
214
215 //
216 // Coordinate the cleanup operation with the oplock state.
217 // Oplock cleanup operations can always cleanup immediately so no
218 // need to check for STATUS_PENDING.
219 //
220
222 Irp,
223 IrpContext,
224 NULL,
225 NULL );
226
227 //
228 // Unlock all outstanding file locks.
229 //
230
231 if (Fcb->FileLock != NULL) {
232
236 NULL );
237 }
238
239 //
240 // Cleanup the cache map.
241 //
242
244
245 //
246 // Check the fast io state.
247 //
248
249 CdLockFcb( IrpContext, Fcb );
250 Fcb->IsFastIoPossible = CdIsFastIoPossible( Fcb );
251 CdUnlockFcb( IrpContext, Fcb );
252
253 break;
254
255 case UserVolumeOpen:
256
257 break;
258
259 default :
260
261#ifdef _MSC_VER
262#pragma prefast( suppress:__WARNING_USE_OTHER_FUNCTION, "argument bogus" )
263#endif
264 CdBugCheck( TypeOfOpen, 0, 0 );
265 }
266
267 //
268 // Now lock the Vcb in order to modify the fields in the in-memory
269 // structures.
270 //
271
272 CdLockVcb( IrpContext, Vcb );
273
274 //
275 // Decrement the cleanup counts in the Vcb and Fcb.
276 //
277
278 CdDecrementCleanupCounts( IrpContext, Fcb );
279
280 //
281 // If the cleanup count hit zero and the volume is not mounted, we
282 // will want to try to spark teardown.
283 //
284
285 AttemptTeardown = (Vcb->VcbCleanup == 0 && Vcb->VcbCondition == VcbNotMounted);
286
287 //
288 // If this file object has locked the volume then perform the unlock operation.
289 // We do this regardless of explicit or implicit (no share DASD open) lock.
290 //
291
292 if (FileObject == Vcb->VolumeLockFileObject) {
293
294 NT_ASSERT( FlagOn( Vcb->VcbState, VCB_STATE_LOCKED));
295
296 IoAcquireVpbSpinLock( &SavedIrql );
297
298 ClearFlag( Vcb->Vpb->Flags, VPB_LOCKED);
299 ClearFlag( Vcb->VcbState, VCB_STATE_LOCKED );
300 Vcb->VolumeLockFileObject = NULL;
301 SendUnlockNotification = TRUE;
302
303 IoReleaseVpbSpinLock( SavedIrql );
304 }
305
306 CdUnlockVcb( IrpContext, Vcb );
307
308 //
309 // We must clean up the share access at this time, since we may not
310 // get a Close call for awhile if the file was mapped through this
311 // File Object.
312 //
313
315
316 } _SEH2_FINALLY {
317
318 CdReleaseFcb( IrpContext, Fcb );
319
320 if (SendUnlockNotification) {
321
323 }
324 } _SEH2_END;
325
326 //
327 // If appropriate, try to spark teardown by purging the volume. Should
328 // this very fileobject we were cleaning up be the last reason for the
329 // volume to remain, teardown will commence on completion of this Irp.
330 //
331
332 if (AttemptTeardown) {
333
334 //
335 // Preacquire CdData here, since the purges will generate closes which
336 // may acquire CdData if there is a possibility of tearing the volume
337 // down.
338 //
339
340 CdAcquireCdData( IrpContext);
341
342 _SEH2_TRY {
343
344 CdAcquireVcbExclusive( IrpContext, Vcb, FALSE );
345 VcbAcquired = TRUE;
346
347 CdPurgeVolume( IrpContext, Vcb, FALSE );
348
349 } _SEH2_FINALLY {
350
351 if (VcbAcquired) { CdReleaseVcb( IrpContext, Vcb ); }
352
353 CdReleaseCdData( IrpContext);
354 } _SEH2_END;
355 }
356
357 //
358 // If this is a normal termination then complete the request
359 //
360
361 CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
362
363 return STATUS_SUCCESS;
364}
365
366
static PIO_STACK_LOCATION IoGetCurrentIrpStackLocation(PIRP Irp)
unsigned char BOOLEAN
LONG NTSTATUS
Definition: precomp.h:26
VOID CdCompleteRequest(_Inout_opt_ PIRP_CONTEXT IrpContext, _Inout_opt_ PIRP Irp, _In_ NTSTATUS Status)
Definition: cddata.c:914
#define ASSERT_IRP(I)
Definition: cddata.h:250
#define ASSERT_IRP_CONTEXT(IC)
Definition: cddata.h:248
#define CdLockFcb(IC, F)
Definition: cdprocs.h:1044
BOOLEAN CdMarkDevForVerifyIfVcbMounted(_Inout_ PVCB Vcb)
Definition: verfysup.c:359
#define CdAcquireCdData(IC)
Definition: cdprocs.h:973
_Inout_ PFILE_OBJECT _In_ TYPE_OF_OPEN TypeOfOpen
Definition: cdprocs.h:589
NTSTATUS CdHijackIrpAndFlushDevice(_In_ PIRP_CONTEXT IrpContext, _Inout_ PIRP Irp, _In_ PDEVICE_OBJECT TargetDeviceObject)
Definition: deviosup.c:4105
#define CdReleaseFile(IC, F)
Definition: cdprocs.h:1003
#define CdReleaseVcb(IC, V)
Definition: cdprocs.h:985
#define CdReleaseFcb(IC, F)
Definition: cdprocs.h:1012
@ StreamFileOpen
Definition: cdprocs.h:574
@ UserDirectoryOpen
Definition: cdprocs.h:576
@ UserFileOpen
Definition: cdprocs.h:577
@ UserVolumeOpen
Definition: cdprocs.h:575
#define CdLockVcb(IC, V)
Definition: cdprocs.h:1023
#define CdGetFcbOplock(F)
Definition: cdprocs.h:1081
#define CdReleaseCdData(IC)
Definition: cdprocs.h:976
#define CdUnlockVcb(IC, V)
Definition: cdprocs.h:1028
_In_ PFCB Fcb
Definition: cdprocs.h:159
_Inout_ PFILE_OBJECT _In_ TYPE_OF_OPEN PFCB _In_opt_ PCCB Ccb
Definition: cdprocs.h:592
#define CdAcquireVcbExclusive(IC, V, I)
Definition: cdprocs.h:979
#define CdDecrementCleanupCounts(IC, F)
Definition: cdprocs.h:1311
#define CdAcquireFileExclusive(IC, F)
Definition: cdprocs.h:994
#define CdAcquireFcbExclusive(IC, F, I)
Definition: cdprocs.h:1006
enum _TYPE_OF_OPEN TYPE_OF_OPEN
#define CdIsFastIoPossible(F)
Definition: cdprocs.h:2015
#define CdUnlockFcb(IC, F)
Definition: cdprocs.h:1060
#define CCB_FLAG_DISMOUNT_ON_CLOSE
Definition: cdstruc.h:1107
#define VCB_STATE_LOCKED
Definition: cdstruc.h:709
@ VcbNotMounted
Definition: cdstruc.h:490
#define _Requires_lock_held_(lock)
_In_ PIRP Irp
Definition: csq.h:116
#define NULL
Definition: types.h:112
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define CdBugCheck(A, B, C)
Definition: nodetype.h:103
UCHAR KIRQL
Definition: env_spec_w32.h:591
#define ClearFlag(_F, _SF)
Definition: ext2fs.h:191
#define SetFlag(_F, _SF)
Definition: ext2fs.h:187
#define FlagOn(_F, _SF)
Definition: ext2fs.h:179
NTSTATUS NTAPI FsRtlFastUnlockAll(IN PFILE_LOCK FileLock, IN PFILE_OBJECT FileObject, IN PEPROCESS Process, IN PVOID Context OPTIONAL)
Definition: filelock.c:1025
#define _SEH2_FINALLY
Definition: filesup.c:21
#define _SEH2_END
Definition: filesup.c:22
#define _SEH2_TRY
Definition: filesup.c:19
BOOLEAN NTAPI CcUninitializeCacheMap(IN PFILE_OBJECT FileObject, IN OPTIONAL PLARGE_INTEGER TruncateSize, IN OPTIONAL PCACHE_UNINITIALIZE_EVENT UninitializeEvent)
Definition: fssup.c:286
#define _Inout_
Definition: ms_sal.h:378
#define FSRTL_VOLUME_UNLOCK
Definition: ntifs_ex.h:443
VOID NTAPI FsRtlNotifyCleanup(IN PNOTIFY_SYNC NotifySync, IN PLIST_ENTRY NotifyList, IN PVOID FsContext)
Definition: notify.c:659
NTSTATUS NTAPI FsRtlNotifyVolumeEvent(IN PFILE_OBJECT FileObject, IN ULONG EventCode)
Definition: pnp.c:38
VOID NTAPI IoRemoveShareAccess(IN PFILE_OBJECT FileObject, IN PSHARE_ACCESS ShareAccess)
Definition: file.c:3478
PEPROCESS NTAPI IoGetRequestorProcess(IN PIRP Irp)
Definition: irp.c:1782
VOID NTAPI IoReleaseVpbSpinLock(IN KIRQL Irql)
Definition: volume.c:1215
VOID NTAPI IoAcquireVpbSpinLock(OUT PKIRQL Irql)
Definition: volume.c:1204
NTSTATUS NTAPI FsRtlCheckOplock(IN POPLOCK Oplock, IN PIRP Irp, IN PVOID Context, IN POPLOCK_WAIT_COMPLETE_ROUTINE CompletionRoutine OPTIONAL, IN POPLOCK_FS_PREPOST_IRP PostIrpRoutine OPTIONAL)
Definition: oplock.c:1170
#define Vcb
Definition: cdprocs.h:1415
#define STATUS_SUCCESS
Definition: shellext.h:65
Definition: cdstruc.h:1067
Definition: cdstruc.h:902
ULONG Flags
Definition: ntfs.h:536
PVCB Vcb
Definition: cdstruc.h:933
SHARE_ACCESS ShareAccess
Definition: cdstruc.h:1009
FILE_LOCK FileLock
Definition: fatstruc.h:1071
PFILE_OBJECT FileObject
Definition: iotypes.h:3169
Definition: cdstruc.h:498
_In_ WDFREQUEST _In_ WDFFILEOBJECT FileObject
Definition: wdfdevice.h:550
#define FO_FILE_MODIFIED
Definition: iotypes.h:1788
#define FO_CLEANUP_COMPLETE
Definition: iotypes.h:1790
* PFILE_OBJECT
Definition: iotypes.h:1998
#define VPB_LOCKED
Definition: iotypes.h:1808
#define NT_ASSERT
Definition: rtlfuncs.h:3310