2 * Copyright (c) 2008, 2009, 2010, 2011 Kernel Drivers, LLC.
3 * Copyright (c) 2009, 2010, 2011 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
14 * this list of conditions and the following disclaimer in the
16 * and/or other materials provided with the distribution.
17 * - Neither the names of Kernel Drivers, LLC and Your File System, Inc.
18 * nor the names of their contributors may be used to endorse or promote
19 * products derived from this software without specific prior written
20 * permission from Kernel Drivers, LLC and Your File System, Inc.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
24 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
25 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
26 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
29 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include "AFSCommon.h"
46 // This function is the IRP_MJ_CLOSE dispatch handler
50 // A status is returned for the handling of this request
54 AFSClose( IN PDEVICE_OBJECT LibDeviceObject,
57 UNREFERENCED_PARAMETER(LibDeviceObject);
58 NTSTATUS ntStatus = STATUS_SUCCESS;
59 IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
61 AFSDeviceExt *pDeviceExt = NULL;
63 AFSObjectInfoCB *pObjectInfo = NULL;
64 AFSDirectoryCB *pDirCB = NULL;
70 if( AFSRDRDeviceObject == NULL)
74 // Let this through, it's an close on the library control device
77 try_return( ntStatus);
80 pDeviceExt = (AFSDeviceExt *)AFSRDRDeviceObject->DeviceExtension;
82 pIrpSp = IoGetCurrentIrpStackLocation( Irp);
84 pFcb = (AFSFcb *)pIrpSp->FileObject->FsContext;
88 try_return( ntStatus);
91 pObjectInfo = pFcb->ObjectInformation;
94 // Perform the close functionality depending on the type of node it is
97 switch( pFcb->Header.NodeTypeCode)
103 AFSPIOCtlOpenCloseRequestCB stPIOCtlClose;
104 AFSFileID stParentFileId;
106 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
107 AFS_TRACE_LEVEL_VERBOSE,
108 "AFSClose Acquiring GlobalRoot lock %p EXCL %08lX\n",
109 &pFcb->NPFcb->Resource,
110 PsGetCurrentThread());
112 AFSAcquireExcl( &pFcb->NPFcb->Resource,
115 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
118 // Send the close to the CM
121 RtlZeroMemory( &stPIOCtlClose,
122 sizeof( AFSPIOCtlOpenCloseRequestCB));
124 stPIOCtlClose.RequestId = pCcb->RequestID;
126 stPIOCtlClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
128 RtlZeroMemory( &stParentFileId,
131 stParentFileId = pObjectInfo->ParentObjectInformation->FileId;
134 // Issue the close request to the service
137 AFSProcessRequest( AFS_REQUEST_TYPE_PIOCTL_CLOSE,
138 AFS_REQUEST_FLAG_SYNCHRONOUS,
142 (void *)&stPIOCtlClose,
143 sizeof( AFSPIOCtlOpenCloseRequestCB),
148 // Remove the Ccb and de-allocate it
155 // If this is not the root then decrement the open child reference count
158 if( pObjectInfo->ParentObjectInformation != NULL &&
159 pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount > 0)
162 InterlockedDecrement( &pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount);
164 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
165 AFS_TRACE_LEVEL_VERBOSE,
166 "AFSClose (IOCtl) Decrement child open ref count on Parent object %p Cnt %d\n",
167 pObjectInfo->ParentObjectInformation,
168 pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount);
171 AFSReleaseResource( &pFcb->NPFcb->Resource);
173 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
175 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
176 AFS_TRACE_LEVEL_VERBOSE,
177 "AFSClose (IOCtl) Decrement count on Fcb %p Cnt %d\n",
181 ASSERT( lCount >= 0);
189 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
190 AFS_TRACE_LEVEL_VERBOSE,
191 "AFSClose Acquiring Special Root ALL lock %p EXCL %08lX\n",
192 &pFcb->NPFcb->Resource,
193 PsGetCurrentThread());
195 AFSAcquireExcl( &pFcb->NPFcb->Resource,
198 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
201 // Remove the Ccb and de-allocate it
207 AFSReleaseResource( &pFcb->NPFcb->Resource);
209 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
211 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
212 AFS_TRACE_LEVEL_VERBOSE,
213 "AFSClose (RootAll) Decrement count on Fcb %p Cnt %d\n",
217 ASSERT( lCount >= 0);
223 // Root, file or directory node
228 case AFS_DIRECTORY_FCB:
229 case AFS_SYMBOLIC_LINK_FCB:
230 case AFS_MOUNT_POINT_FCB:
231 case AFS_DFS_LINK_FCB:
232 case AFS_INVALID_FCB:
235 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
238 // We may be performing some cleanup on the Fcb so grab it exclusive to ensure no collisions
241 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
242 AFS_TRACE_LEVEL_VERBOSE,
243 "AFSClose Acquiring Dcb lock %p EXCL %08lX\n",
244 &pFcb->NPFcb->Resource,
245 PsGetCurrentThread());
247 AFSAcquireExcl( &pFcb->NPFcb->Resource,
250 KeQueryTickCount( &pFcb->ObjectInformation->LastAccessCount);
252 if( pFcb->OpenReferenceCount == 1 &&
253 pFcb->Header.NodeTypeCode == AFS_FILE_FCB)
256 SetFlag( pFcb->Flags, AFS_FCB_FILE_CLOSED);
259 // Attempt to tear down our extent list for the file
260 // If there are remaining dirty extents then attempt to
261 // flush them as well
264 if( pFcb->Specific.File.ExtentsDirtyCount)
267 AFSFlushExtents( pFcb,
272 // Wait for any outstanding queued flushes to complete
275 AFSWaitOnQueuedFlushes( pFcb);
277 ASSERT( pFcb->Specific.File.ExtentsDirtyCount == 0 &&
278 pFcb->Specific.File.QueuedFlushCount == 0);
280 AFSReleaseResource( &pFcb->NPFcb->Resource);
283 // Tear 'em down, we'll not be needing them again
286 AFSTearDownFcbExtents( pFcb,
292 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
293 pFcb->Specific.File.ExtentsDirtyCount &&
294 (pCcb->GrantedAccess & FILE_WRITE_DATA))
297 AFSFlushExtents( pFcb,
301 AFSReleaseResource( &pFcb->NPFcb->Resource);
304 pDirCB = pCcb->DirectoryCB;
307 // Steal the DirOpenReferenceCount from the Ccb
310 pCcb->DirectoryCB = NULL;
313 // Remove the Ccb and de-allocate it
320 // If this entry is deleted then remove the object from the volume tree
323 if( BooleanFlagOn( pDirCB->Flags, AFS_DIR_ENTRY_DELETED))
326 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
327 pObjectInfo->Links == 0)
331 // Stop anything possibly in process
334 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
335 AFS_TRACE_LEVEL_VERBOSE,
336 "AFSClose Acquiring Fcb extents lock %p EXCL %08lX\n",
337 &pFcb->NPFcb->Specific.File.ExtentsResource,
338 PsGetCurrentThread());
340 AFSAcquireExcl( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource,
343 pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestStatus = STATUS_FILE_DELETED;
345 KeSetEvent( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestComplete,
349 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
350 AFS_TRACE_LEVEL_VERBOSE,
351 "AFSClose Releasing Fcb extents lock %p EXCL %08lX\n",
352 &pFcb->NPFcb->Specific.File.ExtentsResource,
353 PsGetCurrentThread());
355 AFSReleaseResource( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource);
358 AFSAcquireExcl( pObjectInfo->ParentObjectInformation->Specific.Directory.DirectoryNodeHdr.TreeLock,
361 AFSAcquireExcl( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock,
364 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
366 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
367 AFS_TRACE_LEVEL_VERBOSE,
368 "AFSClose (Other) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
369 &pDirCB->NameInformation.FileName,
374 ASSERT( lCount >= 0);
379 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
380 AFS_TRACE_LEVEL_VERBOSE,
381 "AFSClose Deleting dir entry %p (%p) for %wZ FID %08lX-%08lX-%08lX-%08lX\n",
384 &pDirCB->NameInformation.FileName,
385 pObjectInfo->FileId.Cell,
386 pObjectInfo->FileId.Volume,
387 pObjectInfo->FileId.Vnode,
388 pObjectInfo->FileId.Unique);
391 // Remove and delete the directory entry from the parent list
394 AFSDeleteDirEntry( pObjectInfo->ParentObjectInformation,
397 AFSAcquireShared( &pObjectInfo->NonPagedInfo->ObjectInfoLock,
400 if( pObjectInfo->ObjectReferenceCount <= 0)
403 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE))
406 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
407 AFS_TRACE_LEVEL_VERBOSE,
408 "AFSClose Removing object %p from volume tree\n",
411 AFSRemoveHashEntry( &pObjectInfo->VolumeCB->ObjectInfoTree.TreeHead,
412 &pObjectInfo->TreeEntry);
414 ClearFlag( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE);
418 AFSReleaseResource( &pObjectInfo->NonPagedInfo->ObjectInfoLock);
421 AFSReleaseResource( pObjectInfo->ParentObjectInformation->Specific.Directory.DirectoryNodeHdr.TreeLock);
423 AFSReleaseResource( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock);
428 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
430 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
431 AFS_TRACE_LEVEL_VERBOSE,
432 "AFSClose (Other2) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
433 &pDirCB->NameInformation.FileName,
438 ASSERT( lCount >= 0);
442 // If this is not the root then decrement the open child reference count
445 if( pObjectInfo != NULL &&
446 pObjectInfo->ParentObjectInformation != NULL &&
447 pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount > 0)
450 InterlockedDecrement( &pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount);
452 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
453 AFS_TRACE_LEVEL_VERBOSE,
454 "AFSClose Decrement child open ref count on Parent object %p Cnt %d\n",
455 pObjectInfo->ParentObjectInformation,
456 pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount);
460 // Decrement the reference count on the Fcb. this is protecting it from teardown.
463 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
465 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
466 AFS_TRACE_LEVEL_VERBOSE,
467 "AFSClose Decrement count on Fcb %p Cnt %d\n",
471 ASSERT( lCount >= 0);
476 case AFS_SPECIAL_SHARE_FCB:
479 AFSPipeOpenCloseRequestCB stPipeClose;
481 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
483 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
484 AFS_TRACE_LEVEL_VERBOSE,
485 "AFSClose Acquiring Special Share lock %p EXCL %08lX\n",
486 &pFcb->NPFcb->Resource,
487 PsGetCurrentThread());
489 AFSAcquireExcl( &pFcb->NPFcb->Resource,
492 RtlZeroMemory( &stPipeClose,
493 sizeof( AFSPipeOpenCloseRequestCB));
495 stPipeClose.RequestId = pCcb->RequestID;
497 stPipeClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
500 // Issue the open request to the service
504 AFSProcessRequest( AFS_REQUEST_TYPE_PIPE_CLOSE,
505 AFS_REQUEST_FLAG_SYNCHRONOUS,
507 &pDirCB->NameInformation.FileName,
509 (void *)&stPipeClose,
510 sizeof( AFSPipeOpenCloseRequestCB),
516 // Remove the Ccb and de-allocate it
523 // If this is not the root then decrement the open child reference count
526 if( pObjectInfo->ParentObjectInformation != NULL &&
527 pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount > 0)
530 lCount = InterlockedDecrement( &pObjectInfo->ParentObjectInformation->Specific.Directory.ChildOpenReferenceCount);
532 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
533 AFS_TRACE_LEVEL_VERBOSE,
534 "AFSClose (Share) Decrement child open ref count on Parent object %p Cnt %d\n",
535 pObjectInfo->ParentObjectInformation,
539 AFSReleaseResource( &pFcb->NPFcb->Resource);
541 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
543 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
544 AFS_TRACE_LEVEL_VERBOSE,
545 "AFSClose (Share) Decrement count on Fcb %p Cnt %d\n",
549 ASSERT( lCount >= 0);
556 AFSDbgLogMsg( AFS_SUBSYSTEM_FILE_PROCESSING,
557 AFS_TRACE_LEVEL_ERROR,
558 "AFSClose Processing unknown node type %d\n",
559 pFcb->Header.NodeTypeCode);
567 // Complete the request
570 AFSCompleteRequest( Irp,
573 __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
578 "EXCEPTION - AFSClose\n");
580 AFSDumpTraceFilesFnc();