389 lines
9.7 KiB
C
389 lines
9.7 KiB
C
|
/*++
|
||
|
|
|
||
|
|
Copyright (c) 1989-2000 Microsoft Corporation
|
||
|
|
|
||
|
|
Module Name:
|
||
|
|
|
||
|
|
Cleanup.c
|
||
|
|
|
||
|
|
Abstract:
|
||
|
|
|
||
|
|
This module implements the File Cleanup routine for Udfs called by the
|
||
|
|
dispatch driver.
|
||
|
|
|
||
|
|
// @@BEGIN_DDKSPLIT
|
||
|
|
|
||
|
|
Author:
|
||
|
|
|
||
|
|
Dan Lovinger [DanLo] 31-Oct-1996
|
||
|
|
|
||
|
|
Revision History:
|
||
|
|
|
||
|
|
// @@END_DDKSPLIT
|
||
|
|
|
||
|
|
--*/
|
||
|
|
|
||
|
|
#include "UdfProcs.h"
|
||
|
|
|
||
|
|
//
|
||
|
|
// The Bug check file id for this module
|
||
|
|
//
|
||
|
|
|
||
|
|
#define BugCheckFileId (UDFS_BUG_CHECK_CLEANUP)
|
||
|
|
|
||
|
|
//
|
||
|
|
// The local debug trace level
|
||
|
|
//
|
||
|
|
|
||
|
|
#define Dbg (UDFS_DEBUG_LEVEL_CLEANUP)
|
||
|
|
|
||
|
|
|
||
|
|
NTSTATUS
|
||
|
|
UdfCommonCleanup (
|
||
|
|
IN PIRP_CONTEXT IrpContext,
|
||
|
|
IN PIRP Irp
|
||
|
|
)
|
||
|
|
|
||
|
|
/*++
|
||
|
|
|
||
|
|
Routine Description:
|
||
|
|
|
||
|
|
This is the common routine for cleanup of a file/directory called by both
|
||
|
|
the fsd and fsp threads.
|
||
|
|
|
||
|
|
Cleanup is invoked whenever the last handle to a file object is closed.
|
||
|
|
This is different than the Close operation which is invoked when the last
|
||
|
|
reference to a file object is deleted.
|
||
|
|
|
||
|
|
The function of cleanup is to essentially "cleanup" the file/directory
|
||
|
|
after a user is done with it. The Fcb/Dcb remains around (because MM
|
||
|
|
still has the file object referenced) but is now available for another
|
||
|
|
user to open (i.e., as far as the user is concerned the is now closed).
|
||
|
|
|
||
|
|
See close for a more complete description of what close does.
|
||
|
|
|
||
|
|
We do no synchronization in this routine until we get to the point
|
||
|
|
where we modify the counts, share access and volume lock field.
|
||
|
|
|
||
|
|
We need to update the Fcb and Vcb to show that a user handle has been closed.
|
||
|
|
The following structures and fields are affected.
|
||
|
|
|
||
|
|
Vcb:
|
||
|
|
|
||
|
|
VolumeLockFileObject - Did the user lock the volume with this file object.
|
||
|
|
VcbState - Check if we are unlocking the volume here.
|
||
|
|
VcbCleanup - Count of outstanding handles on the volume.
|
||
|
|
DirNotifyQueue - If this file object has pending DirNotify Irps.
|
||
|
|
|
||
|
|
Fcb:
|
||
|
|
|
||
|
|
ShareAccess - If this is a user handle.
|
||
|
|
FcbCleanup - Count of outstanding handles on this Fcb.
|
||
|
|
Oplock - Any outstanding oplocks on this file object.
|
||
|
|
FileLock - Any outstanding filelocks on this file object.
|
||
|
|
|
||
|
|
Arguments:
|
||
|
|
|
||
|
|
Irp - Supplies the Irp to process
|
||
|
|
|
||
|
|
Return Value:
|
||
|
|
|
||
|
|
NTSTATUS - The return status for the operation.
|
||
|
|
|
||
|
|
--*/
|
||
|
|
|
||
|
|
{
|
||
|
|
PFILE_OBJECT FileObject;
|
||
|
|
TYPE_OF_OPEN TypeOfOpen;
|
||
|
|
|
||
|
|
BOOLEAN SendUnlockNotification = FALSE;
|
||
|
|
BOOLEAN AttemptTeardown;
|
||
|
|
BOOLEAN VcbAcquired = FALSE;
|
||
|
|
|
||
|
|
PVCB Vcb;
|
||
|
|
PFCB Fcb;
|
||
|
|
PCCB Ccb;
|
||
|
|
|
||
|
|
KIRQL SavedIrql;
|
||
|
|
|
||
|
|
ASSERT_IRP_CONTEXT( IrpContext );
|
||
|
|
ASSERT_IRP( Irp );
|
||
|
|
|
||
|
|
//
|
||
|
|
// If we were called with our file system device object instead of a
|
||
|
|
// volume device object, just complete this request with STATUS_SUCCESS.
|
||
|
|
//
|
||
|
|
|
||
|
|
if (IrpContext->Vcb == NULL) {
|
||
|
|
|
||
|
|
UdfCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
|
||
|
|
return STATUS_SUCCESS;
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Get the file object out of the Irp and decode the type of open.
|
||
|
|
//
|
||
|
|
|
||
|
|
FileObject = IoGetCurrentIrpStackLocation( Irp )->FileObject;
|
||
|
|
|
||
|
|
TypeOfOpen = UdfDecodeFileObject( FileObject,
|
||
|
|
&Fcb,
|
||
|
|
&Ccb );
|
||
|
|
|
||
|
|
//
|
||
|
|
// No work here for either an UnopenedFile object or a StreamFileObject.
|
||
|
|
//
|
||
|
|
|
||
|
|
if (TypeOfOpen <= StreamFileOpen) {
|
||
|
|
|
||
|
|
UdfCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
|
||
|
|
|
||
|
|
return STATUS_SUCCESS;
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Keep a local pointer to the Vcb.
|
||
|
|
//
|
||
|
|
|
||
|
|
Vcb = Fcb->Vcb;
|
||
|
|
|
||
|
|
//
|
||
|
|
// If we're closing a volume handle, and writes were made,
|
||
|
|
// hold the Vcb exclusive
|
||
|
|
//
|
||
|
|
|
||
|
|
if ((TypeOfOpen == UserVolumeOpen) &&
|
||
|
|
FlagOn(FileObject->Flags, FO_FILE_MODIFIED)) {
|
||
|
|
|
||
|
|
UdfAcquireVcbExclusive( IrpContext, Vcb, FALSE);
|
||
|
|
VcbAcquired = TRUE;
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Synchronise with reads while we set the cleanup complete
|
||
|
|
// flag on this fileobject. Once this flag is set, any further
|
||
|
|
// reads will be rejected (CdVerifyFcbOperation)
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfAcquireFileExclusive( IrpContext, Fcb);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Set the flag in the FileObject to indicate that cleanup is complete.
|
||
|
|
//
|
||
|
|
|
||
|
|
SetFlag( FileObject->Flags, FO_CLEANUP_COMPLETE );
|
||
|
|
|
||
|
|
UdfReleaseFile( IrpContext, Fcb);
|
||
|
|
|
||
|
|
//
|
||
|
|
// Acquire the current file.
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfAcquireFcbExclusive( IrpContext, Fcb, FALSE );
|
||
|
|
|
||
|
|
//
|
||
|
|
// Use a try-finally to facilitate cleanup.
|
||
|
|
//
|
||
|
|
|
||
|
|
try {
|
||
|
|
|
||
|
|
//
|
||
|
|
// Case on the type of open that we are trying to cleanup.
|
||
|
|
//
|
||
|
|
|
||
|
|
switch (TypeOfOpen) {
|
||
|
|
|
||
|
|
case UserDirectoryOpen:
|
||
|
|
|
||
|
|
DebugTrace(( +1, Dbg,
|
||
|
|
"UdfCommonCleanup, Fcb %08x FO %08x DIR\n",
|
||
|
|
Fcb,
|
||
|
|
FileObject ));
|
||
|
|
|
||
|
|
//
|
||
|
|
// Check if we need to complete any dir notify Irps on this file object.
|
||
|
|
//
|
||
|
|
|
||
|
|
FsRtlNotifyCleanup( Vcb->NotifySync,
|
||
|
|
&Vcb->DirNotifyList,
|
||
|
|
Ccb );
|
||
|
|
|
||
|
|
break;
|
||
|
|
|
||
|
|
case UserFileOpen:
|
||
|
|
|
||
|
|
DebugTrace(( +1, Dbg,
|
||
|
|
"UdfCommonCleanup, Fcb %08x FO %08x FILE\n",
|
||
|
|
Fcb,
|
||
|
|
FileObject ));
|
||
|
|
|
||
|
|
//
|
||
|
|
// Coordinate the cleanup operation with the oplock state.
|
||
|
|
// Oplock cleanup operations can always cleanup immediately so no
|
||
|
|
// need to check for STATUS_PENDING.
|
||
|
|
//
|
||
|
|
|
||
|
|
FsRtlCheckOplock( &Fcb->Oplock,
|
||
|
|
Irp,
|
||
|
|
IrpContext,
|
||
|
|
NULL,
|
||
|
|
NULL );
|
||
|
|
|
||
|
|
//
|
||
|
|
// Unlock all outstanding file locks.
|
||
|
|
//
|
||
|
|
|
||
|
|
if (Fcb->FileLock != NULL) {
|
||
|
|
|
||
|
|
FsRtlFastUnlockAll( Fcb->FileLock,
|
||
|
|
FileObject,
|
||
|
|
IoGetRequestorProcess( Irp ),
|
||
|
|
NULL );
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Cleanup the cache map.
|
||
|
|
//
|
||
|
|
|
||
|
|
CcUninitializeCacheMap( FileObject, NULL, NULL );
|
||
|
|
|
||
|
|
//
|
||
|
|
// Check the fast io state.
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfLockFcb( IrpContext, Fcb );
|
||
|
|
Fcb->IsFastIoPossible = UdfIsFastIoPossible( Fcb );
|
||
|
|
UdfUnlockFcb( IrpContext, Fcb );
|
||
|
|
|
||
|
|
break;
|
||
|
|
|
||
|
|
case UserVolumeOpen :
|
||
|
|
|
||
|
|
DebugTrace(( +1, Dbg,
|
||
|
|
"UdfCommonCleanup, Fcb %08x FO %08x VOL\n",
|
||
|
|
Fcb,
|
||
|
|
FileObject ));
|
||
|
|
|
||
|
|
//
|
||
|
|
// If this handle had write access, and actually wrote something,
|
||
|
|
// flush the device buffers, and then set the verify bit now
|
||
|
|
// just to be safe (in case there is no dismount).
|
||
|
|
//
|
||
|
|
|
||
|
|
if (FileObject->WriteAccess &&
|
||
|
|
FlagOn(FileObject->Flags, FO_FILE_MODIFIED)) {
|
||
|
|
|
||
|
|
(VOID)UdfHijackIrpAndFlushDevice( IrpContext,
|
||
|
|
Irp,
|
||
|
|
Vcb->TargetDeviceObject );
|
||
|
|
|
||
|
|
UdfMarkRealDevForVerify( Vcb->Vpb->RealDevice);
|
||
|
|
}
|
||
|
|
|
||
|
|
break;
|
||
|
|
|
||
|
|
default :
|
||
|
|
|
||
|
|
UdfBugCheck( TypeOfOpen, 0, 0 );
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// Now lock the Vcb in order to modify the fields in the in-memory
|
||
|
|
// structures.
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfLockVcb( IrpContext, Vcb );
|
||
|
|
|
||
|
|
//
|
||
|
|
// Decrement the cleanup counts in the Vcb and Fcb.
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfDecrementCleanupCounts( IrpContext, Fcb );
|
||
|
|
|
||
|
|
//
|
||
|
|
// If the cleanup count hit zero and the volume is not mounted, we
|
||
|
|
// will want to try to spark teardown.
|
||
|
|
//
|
||
|
|
|
||
|
|
AttemptTeardown = (Vcb->VcbCleanup == 0 && Vcb->VcbCondition == VcbNotMounted);
|
||
|
|
|
||
|
|
//
|
||
|
|
// If this file object has locked the volume then perform the unlock operation.
|
||
|
|
// We do this regardless of explicit or implicit (no share DASD open) lock.
|
||
|
|
//
|
||
|
|
|
||
|
|
if (FileObject == Vcb->VolumeLockFileObject) {
|
||
|
|
|
||
|
|
ASSERT( FlagOn( Vcb->VcbState, VCB_STATE_LOCKED));
|
||
|
|
|
||
|
|
IoAcquireVpbSpinLock( &SavedIrql );
|
||
|
|
|
||
|
|
ClearFlag( Vcb->VcbState, VCB_STATE_LOCKED );
|
||
|
|
ClearFlag( Vcb->Vpb->Flags, VPB_LOCKED );
|
||
|
|
Vcb->VolumeLockFileObject = NULL;
|
||
|
|
SendUnlockNotification = TRUE;
|
||
|
|
|
||
|
|
IoReleaseVpbSpinLock( SavedIrql );
|
||
|
|
}
|
||
|
|
|
||
|
|
UdfUnlockVcb( IrpContext, Vcb );
|
||
|
|
|
||
|
|
//
|
||
|
|
// We must clean up the share access at this time, since we may not
|
||
|
|
// get a Close call for awhile if the file was mapped through this
|
||
|
|
// File Object.
|
||
|
|
//
|
||
|
|
|
||
|
|
IoRemoveShareAccess( FileObject, &Fcb->ShareAccess );
|
||
|
|
|
||
|
|
}
|
||
|
|
finally {
|
||
|
|
|
||
|
|
UdfReleaseFcb( IrpContext, Fcb );
|
||
|
|
|
||
|
|
if (SendUnlockNotification) {
|
||
|
|
|
||
|
|
FsRtlNotifyVolumeEvent( FileObject, FSRTL_VOLUME_UNLOCK );
|
||
|
|
}
|
||
|
|
|
||
|
|
if (VcbAcquired) {
|
||
|
|
|
||
|
|
UdfReleaseVcb( IrpContext, Vcb);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
DebugTrace(( -1, Dbg,
|
||
|
|
"UdfCommonCleanup, Fcb %08x FO %08x -> SUCCESS\n",
|
||
|
|
Fcb,
|
||
|
|
FileObject ));
|
||
|
|
|
||
|
|
//
|
||
|
|
// If appropriate, try to spark teardown by purging the volume. Should
|
||
|
|
// this very fileobject we were cleaning up be the last reason for the
|
||
|
|
// volume to remain, teardown will commence on completion of this Irp.
|
||
|
|
//
|
||
|
|
|
||
|
|
if (AttemptTeardown) {
|
||
|
|
|
||
|
|
UdfAcquireVcbExclusive( IrpContext, Vcb, FALSE );
|
||
|
|
|
||
|
|
try {
|
||
|
|
|
||
|
|
UdfPurgeVolume( IrpContext, Vcb, FALSE );
|
||
|
|
|
||
|
|
} finally {
|
||
|
|
|
||
|
|
UdfReleaseVcb( IrpContext, Vcb );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
//
|
||
|
|
// If this is a normal termination then complete the request
|
||
|
|
//
|
||
|
|
|
||
|
|
UdfCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
|
||
|
|
|
||
|
|
return STATUS_SUCCESS;
|
||
|
|
}
|
||
|
|
|