2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Kernel Drivers, LLC.
3 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Your File System, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * - Redistributions of source code must retain the above copyright notice,
11 * this list of conditions and the following disclaimer.
12 * - Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * - Neither the names of Kernel Drivers, LLC and Your File System, Inc.
16 * nor the names of their contributors may be used to endorse or promote
17 * products derived from this software without specific prior written
18 * permission from Kernel Drivers, LLC and Your File System, Inc.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
23 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
24 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 #include "AFSCommon.h"
44 // This function is the IRP_MJ_CLOSE dispatch handler
48 // A status is returned for the handling of this request
52 AFSClose( IN PDEVICE_OBJECT LibDeviceObject,
55 UNREFERENCED_PARAMETER(LibDeviceObject);
56 NTSTATUS ntStatus = STATUS_SUCCESS;
57 IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
59 AFSDeviceExt *pDeviceExt = NULL;
61 AFSObjectInfoCB *pObjectInfo = NULL;
62 AFSObjectInfoCB *pParentObjectInfo = NULL;
63 AFSDirectoryCB *pDirCB = NULL;
69 if( AFSRDRDeviceObject == NULL)
73 // Let this through, it's an close on the library control device
76 try_return( ntStatus);
79 pDeviceExt = (AFSDeviceExt *)AFSRDRDeviceObject->DeviceExtension;
81 pIrpSp = IoGetCurrentIrpStackLocation( Irp);
83 pFcb = (AFSFcb *)pIrpSp->FileObject->FsContext;
87 try_return( ntStatus);
90 pObjectInfo = pFcb->ObjectInformation;
93 // Perform the close functionality depending on the type of node it is
96 switch( pFcb->Header.NodeTypeCode)
102 AFSPIOCtlOpenCloseRequestCB stPIOCtlClose;
103 AFSFileID stParentFileId;
105 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
106 AFS_TRACE_LEVEL_VERBOSE,
107 "AFSClose Acquiring GlobalRoot lock %p EXCL %08lX\n",
108 &pFcb->NPFcb->Resource,
109 PsGetCurrentThread()));
111 AFSAcquireExcl( &pFcb->NPFcb->Resource,
114 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
116 pIrpSp->FileObject->FsContext2 = NULL;
119 // Send the close to the CM
122 RtlZeroMemory( &stPIOCtlClose,
123 sizeof( AFSPIOCtlOpenCloseRequestCB));
125 stPIOCtlClose.RequestId = pCcb->RequestID;
127 stPIOCtlClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
129 RtlZeroMemory( &stParentFileId,
132 stParentFileId = pObjectInfo->ParentFileId;
135 // Issue the close request to the service
138 AFSProcessRequest( AFS_REQUEST_TYPE_PIOCTL_CLOSE,
139 AFS_REQUEST_FLAG_SYNCHRONOUS,
145 (void *)&stPIOCtlClose,
146 sizeof( AFSPIOCtlOpenCloseRequestCB),
151 // Remove the Ccb and de-allocate it
158 // If this is not the root then decrement the open child reference count
161 if ( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
164 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
165 &pObjectInfo->ParentFileId,
169 if( pParentObjectInfo != NULL &&
170 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
173 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
175 AFSDbgTrace(( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
176 AFS_TRACE_LEVEL_VERBOSE,
177 "AFSClose (IOCtl) Decrement child open ref count on Parent object %p Cnt %d\n",
179 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount));
182 AFSReleaseResource( &pFcb->NPFcb->Resource);
184 pIrpSp->FileObject->FsContext = NULL;
186 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
188 AFSDbgTrace(( AFS_SUBSYSTEM_FCB_REF_COUNTING,
189 AFS_TRACE_LEVEL_VERBOSE,
190 "AFSClose (IOCtl) Decrement count on Fcb %p Cnt %d\n",
194 ASSERT( lCount >= 0);
202 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
203 AFS_TRACE_LEVEL_VERBOSE,
204 "AFSClose Acquiring Special Root ALL lock %p EXCL %08lX\n",
205 &pFcb->NPFcb->Resource,
206 PsGetCurrentThread()));
208 AFSAcquireExcl( &pFcb->NPFcb->Resource,
211 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
213 pIrpSp->FileObject->FsContext2;
216 // Remove the Ccb and de-allocate it
222 AFSReleaseResource( &pFcb->NPFcb->Resource);
224 pIrpSp->FileObject->FsContext = NULL;
226 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
228 AFSDbgTrace(( AFS_SUBSYSTEM_FCB_REF_COUNTING,
229 AFS_TRACE_LEVEL_VERBOSE,
230 "AFSClose (RootAll) Decrement count on Fcb %p Cnt %d\n",
234 ASSERT( lCount >= 0);
240 // Root, file or directory node
245 case AFS_DIRECTORY_FCB:
246 case AFS_SYMBOLIC_LINK_FCB:
247 case AFS_MOUNT_POINT_FCB:
248 case AFS_DFS_LINK_FCB:
249 case AFS_INVALID_FCB:
252 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
254 pIrpSp->FileObject->FsContext2 = NULL;
257 // We may be performing some cleanup on the Fcb so grab it exclusive to ensure no collisions
260 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
261 AFS_TRACE_LEVEL_VERBOSE,
262 "AFSClose Acquiring Dcb lock %p EXCL %08lX\n",
263 &pFcb->NPFcb->Resource,
264 PsGetCurrentThread()));
266 AFSAcquireExcl( &pFcb->NPFcb->Resource,
269 KeQueryTickCount( &pFcb->ObjectInformation->LastAccessCount);
271 if( pFcb->OpenReferenceCount == 1 &&
272 pFcb->Header.NodeTypeCode == AFS_FILE_FCB)
275 SetFlag( pFcb->Flags, AFS_FCB_FILE_CLOSED);
278 // Attempt to tear down our extent list for the file
279 // If there are remaining dirty extents then attempt to
280 // flush them as well
283 if( pFcb->Specific.File.ExtentsDirtyCount)
286 AFSFlushExtents( pFcb,
291 // Wait for any outstanding queued flushes to complete
294 AFSWaitOnQueuedFlushes( pFcb);
296 ASSERT( pFcb->Specific.File.ExtentsDirtyCount == 0 &&
297 pFcb->Specific.File.QueuedFlushCount == 0);
299 AFSReleaseResource( &pFcb->NPFcb->Resource);
302 // Tear 'em down, we'll not be needing them again
305 AFSTearDownFcbExtents( pFcb,
311 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
312 pFcb->Specific.File.ExtentsDirtyCount &&
313 (pCcb->GrantedAccess & FILE_WRITE_DATA))
316 AFSFlushExtents( pFcb,
320 AFSReleaseResource( &pFcb->NPFcb->Resource);
323 pDirCB = pCcb->DirectoryCB;
326 // Steal the DirOpenReferenceCount from the Ccb
329 pCcb->DirectoryCB = NULL;
332 // Object the Parent ObjectInformationCB
335 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
338 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
339 &pObjectInfo->ParentFileId,
344 // Remove the Ccb and de-allocate it
351 // If this entry is deleted then remove the object from the volume tree
354 if( BooleanFlagOn( pDirCB->Flags, AFS_DIR_ENTRY_DELETED))
357 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
358 pObjectInfo->Links == 0)
362 // Stop anything possibly in process
365 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
366 AFS_TRACE_LEVEL_VERBOSE,
367 "AFSClose Acquiring Fcb extents lock %p EXCL %08lX\n",
368 &pFcb->NPFcb->Specific.File.ExtentsResource,
369 PsGetCurrentThread()));
371 AFSAcquireExcl( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource,
374 pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestStatus = STATUS_FILE_DELETED;
376 KeSetEvent( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestComplete,
380 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
381 AFS_TRACE_LEVEL_VERBOSE,
382 "AFSClose Releasing Fcb extents lock %p EXCL %08lX\n",
383 &pFcb->NPFcb->Specific.File.ExtentsResource,
384 PsGetCurrentThread()));
386 AFSReleaseResource( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource);
389 ASSERT( pParentObjectInfo != NULL);
391 if ( pParentObjectInfo != NULL)
393 AFSAcquireExcl( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock,
396 AFSAcquireExcl( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock,
399 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
401 AFSDbgTrace(( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
402 AFS_TRACE_LEVEL_VERBOSE,
403 "AFSClose (Other) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
404 &pDirCB->NameInformation.FileName,
409 ASSERT( lCount >= 0);
412 pDirCB->NameArrayReferenceCount <= 0)
415 AFSDbgTrace(( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
416 AFS_TRACE_LEVEL_VERBOSE,
417 "AFSClose Deleting dir entry %p (%p) for %wZ FID %08lX-%08lX-%08lX-%08lX\n",
420 &pDirCB->NameInformation.FileName,
421 pObjectInfo->FileId.Cell,
422 pObjectInfo->FileId.Volume,
423 pObjectInfo->FileId.Vnode,
424 pObjectInfo->FileId.Unique));
427 // Remove and delete the directory entry from the parent list
430 AFSDeleteDirEntry( pParentObjectInfo,
433 AFSAcquireShared( &pObjectInfo->NonPagedInfo->ObjectInfoLock,
436 if( pObjectInfo->ObjectReferenceCount <= 0)
439 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE))
442 AFSDbgTrace(( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
443 AFS_TRACE_LEVEL_VERBOSE,
444 "AFSClose Removing object %p from volume tree\n",
447 AFSRemoveHashEntry( &pObjectInfo->VolumeCB->ObjectInfoTree.TreeHead,
448 &pObjectInfo->TreeEntry);
450 ClearFlag( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE);
454 AFSReleaseResource( &pObjectInfo->NonPagedInfo->ObjectInfoLock);
457 AFSReleaseResource( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock);
459 AFSReleaseResource( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock);
465 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
467 AFSDbgTrace(( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
468 AFS_TRACE_LEVEL_VERBOSE,
469 "AFSClose (Other2) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
470 &pDirCB->NameInformation.FileName,
475 ASSERT( lCount >= 0);
479 // If this is not the root then decrement the open child reference count
482 if( pObjectInfo != NULL &&
483 pParentObjectInfo != NULL &&
484 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
487 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
489 AFSDbgTrace(( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
490 AFS_TRACE_LEVEL_VERBOSE,
491 "AFSClose Decrement child open ref count on Parent object %p Cnt %d\n",
493 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount));
496 pIrpSp->FileObject->FsContext = NULL;
499 // Decrement the reference count on the Fcb. this is protecting it from teardown.
502 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
504 AFSDbgTrace(( AFS_SUBSYSTEM_FCB_REF_COUNTING,
505 AFS_TRACE_LEVEL_VERBOSE,
506 "AFSClose Decrement count on Fcb %p Cnt %d\n",
510 ASSERT( lCount >= 0);
515 case AFS_SPECIAL_SHARE_FCB:
518 AFSPipeOpenCloseRequestCB stPipeClose;
520 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
522 pIrpSp->FileObject->FsContext2 = NULL;
525 // Object the Parent ObjectInformationCB
528 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
531 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
532 &pObjectInfo->ParentFileId,
536 AFSDbgTrace(( AFS_SUBSYSTEM_LOCK_PROCESSING,
537 AFS_TRACE_LEVEL_VERBOSE,
538 "AFSClose Acquiring Special Share lock %p EXCL %08lX\n",
539 &pFcb->NPFcb->Resource,
540 PsGetCurrentThread()));
542 AFSAcquireExcl( &pFcb->NPFcb->Resource,
545 RtlZeroMemory( &stPipeClose,
546 sizeof( AFSPipeOpenCloseRequestCB));
548 stPipeClose.RequestId = pCcb->RequestID;
550 stPipeClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
553 // Remove the Ccb and de-allocate it
560 // If this is not the root then decrement the open child reference count
563 if( pParentObjectInfo != NULL &&
564 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
567 lCount = InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
569 AFSDbgTrace(( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
570 AFS_TRACE_LEVEL_VERBOSE,
571 "AFSClose (Share) Decrement child open ref count on Parent object %p Cnt %d\n",
576 AFSReleaseResource( &pFcb->NPFcb->Resource);
578 pIrpSp->FileObject->FsContext = NULL;
580 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
582 AFSDbgTrace(( AFS_SUBSYSTEM_FCB_REF_COUNTING,
583 AFS_TRACE_LEVEL_VERBOSE,
584 "AFSClose (Share) Decrement count on Fcb %p Cnt %d\n",
588 ASSERT( lCount >= 0);
596 AFSDbgTrace(( AFS_SUBSYSTEM_FILE_PROCESSING,
597 AFS_TRACE_LEVEL_ERROR,
598 "AFSClose Processing unknown node type %d\n",
599 pFcb->Header.NodeTypeCode));
608 // Complete the request
611 AFSCompleteRequest( Irp,
614 __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
619 "EXCEPTION - AFSClose\n"));
621 AFSDumpTraceFilesFnc();
624 if ( pParentObjectInfo != NULL)
627 AFSReleaseObjectInfo( &pParentObjectInfo);