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 AFSObjectInfoCB *pParentObjectInfo = NULL;
65 AFSDirectoryCB *pDirCB = NULL;
71 if( AFSRDRDeviceObject == NULL)
75 // Let this through, it's an close on the library control device
78 try_return( ntStatus);
81 pDeviceExt = (AFSDeviceExt *)AFSRDRDeviceObject->DeviceExtension;
83 pIrpSp = IoGetCurrentIrpStackLocation( Irp);
85 pFcb = (AFSFcb *)pIrpSp->FileObject->FsContext;
89 try_return( ntStatus);
92 pObjectInfo = pFcb->ObjectInformation;
95 // Perform the close functionality depending on the type of node it is
98 switch( pFcb->Header.NodeTypeCode)
104 AFSPIOCtlOpenCloseRequestCB stPIOCtlClose;
105 AFSFileID stParentFileId;
107 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
108 AFS_TRACE_LEVEL_VERBOSE,
109 "AFSClose Acquiring GlobalRoot lock %p EXCL %08lX\n",
110 &pFcb->NPFcb->Resource,
111 PsGetCurrentThread());
113 AFSAcquireExcl( &pFcb->NPFcb->Resource,
116 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
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,
143 (void *)&stPIOCtlClose,
144 sizeof( AFSPIOCtlOpenCloseRequestCB),
149 // Remove the Ccb and de-allocate it
156 // If this is not the root then decrement the open child reference count
159 if ( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
162 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
163 &pObjectInfo->ParentFileId);
166 if( pParentObjectInfo != NULL &&
167 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
170 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
172 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
173 AFS_TRACE_LEVEL_VERBOSE,
174 "AFSClose (IOCtl) Decrement child open ref count on Parent object %p Cnt %d\n",
176 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
179 AFSReleaseResource( &pFcb->NPFcb->Resource);
181 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
183 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
184 AFS_TRACE_LEVEL_VERBOSE,
185 "AFSClose (IOCtl) Decrement count on Fcb %p Cnt %d\n",
189 ASSERT( lCount >= 0);
197 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
198 AFS_TRACE_LEVEL_VERBOSE,
199 "AFSClose Acquiring Special Root ALL lock %p EXCL %08lX\n",
200 &pFcb->NPFcb->Resource,
201 PsGetCurrentThread());
203 AFSAcquireExcl( &pFcb->NPFcb->Resource,
206 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
209 // Remove the Ccb and de-allocate it
215 AFSReleaseResource( &pFcb->NPFcb->Resource);
217 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
219 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
220 AFS_TRACE_LEVEL_VERBOSE,
221 "AFSClose (RootAll) Decrement count on Fcb %p Cnt %d\n",
225 ASSERT( lCount >= 0);
231 // Root, file or directory node
236 case AFS_DIRECTORY_FCB:
237 case AFS_SYMBOLIC_LINK_FCB:
238 case AFS_MOUNT_POINT_FCB:
239 case AFS_DFS_LINK_FCB:
240 case AFS_INVALID_FCB:
243 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
246 // We may be performing some cleanup on the Fcb so grab it exclusive to ensure no collisions
249 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
250 AFS_TRACE_LEVEL_VERBOSE,
251 "AFSClose Acquiring Dcb lock %p EXCL %08lX\n",
252 &pFcb->NPFcb->Resource,
253 PsGetCurrentThread());
255 AFSAcquireExcl( &pFcb->NPFcb->Resource,
258 KeQueryTickCount( &pFcb->ObjectInformation->LastAccessCount);
260 if( pFcb->OpenReferenceCount == 1 &&
261 pFcb->Header.NodeTypeCode == AFS_FILE_FCB)
264 SetFlag( pFcb->Flags, AFS_FCB_FILE_CLOSED);
267 // Attempt to tear down our extent list for the file
268 // If there are remaining dirty extents then attempt to
269 // flush them as well
272 if( pFcb->Specific.File.ExtentsDirtyCount)
275 AFSFlushExtents( pFcb,
280 // Wait for any outstanding queued flushes to complete
283 AFSWaitOnQueuedFlushes( pFcb);
285 ASSERT( pFcb->Specific.File.ExtentsDirtyCount == 0 &&
286 pFcb->Specific.File.QueuedFlushCount == 0);
288 AFSReleaseResource( &pFcb->NPFcb->Resource);
291 // Tear 'em down, we'll not be needing them again
294 AFSTearDownFcbExtents( pFcb,
300 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
301 pFcb->Specific.File.ExtentsDirtyCount &&
302 (pCcb->GrantedAccess & FILE_WRITE_DATA))
305 AFSFlushExtents( pFcb,
309 AFSReleaseResource( &pFcb->NPFcb->Resource);
312 pDirCB = pCcb->DirectoryCB;
315 // Steal the DirOpenReferenceCount from the Ccb
318 pCcb->DirectoryCB = NULL;
321 // Object the Parent ObjectInformationCB
324 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
327 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
328 &pObjectInfo->ParentFileId);
332 // Remove the Ccb and de-allocate it
339 // If this entry is deleted then remove the object from the volume tree
342 if( BooleanFlagOn( pDirCB->Flags, AFS_DIR_ENTRY_DELETED))
345 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
346 pObjectInfo->Links == 0)
350 // Stop anything possibly in process
353 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
354 AFS_TRACE_LEVEL_VERBOSE,
355 "AFSClose Acquiring Fcb extents lock %p EXCL %08lX\n",
356 &pFcb->NPFcb->Specific.File.ExtentsResource,
357 PsGetCurrentThread());
359 AFSAcquireExcl( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource,
362 pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestStatus = STATUS_FILE_DELETED;
364 KeSetEvent( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestComplete,
368 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
369 AFS_TRACE_LEVEL_VERBOSE,
370 "AFSClose Releasing Fcb extents lock %p EXCL %08lX\n",
371 &pFcb->NPFcb->Specific.File.ExtentsResource,
372 PsGetCurrentThread());
374 AFSReleaseResource( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource);
377 ASSERT( pParentObjectInfo != NULL);
379 if ( pParentObjectInfo != NULL)
381 AFSAcquireExcl( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock,
384 AFSAcquireExcl( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock,
387 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
389 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
390 AFS_TRACE_LEVEL_VERBOSE,
391 "AFSClose (Other) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
392 &pDirCB->NameInformation.FileName,
397 ASSERT( lCount >= 0);
402 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
403 AFS_TRACE_LEVEL_VERBOSE,
404 "AFSClose Deleting dir entry %p (%p) for %wZ FID %08lX-%08lX-%08lX-%08lX\n",
407 &pDirCB->NameInformation.FileName,
408 pObjectInfo->FileId.Cell,
409 pObjectInfo->FileId.Volume,
410 pObjectInfo->FileId.Vnode,
411 pObjectInfo->FileId.Unique);
414 // Remove and delete the directory entry from the parent list
417 AFSDeleteDirEntry( pParentObjectInfo,
420 AFSAcquireShared( &pObjectInfo->NonPagedInfo->ObjectInfoLock,
423 if( pObjectInfo->ObjectReferenceCount <= 0)
426 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE))
429 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
430 AFS_TRACE_LEVEL_VERBOSE,
431 "AFSClose Removing object %p from volume tree\n",
434 AFSRemoveHashEntry( &pObjectInfo->VolumeCB->ObjectInfoTree.TreeHead,
435 &pObjectInfo->TreeEntry);
437 ClearFlag( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE);
441 AFSReleaseResource( &pObjectInfo->NonPagedInfo->ObjectInfoLock);
444 AFSReleaseResource( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock);
446 AFSReleaseResource( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock);
452 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
454 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
455 AFS_TRACE_LEVEL_VERBOSE,
456 "AFSClose (Other2) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
457 &pDirCB->NameInformation.FileName,
462 ASSERT( lCount >= 0);
466 // If this is not the root then decrement the open child reference count
469 if( pObjectInfo != NULL &&
470 pParentObjectInfo != NULL &&
471 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
474 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
476 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
477 AFS_TRACE_LEVEL_VERBOSE,
478 "AFSClose Decrement child open ref count on Parent object %p Cnt %d\n",
480 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
484 // Decrement the reference count on the Fcb. this is protecting it from teardown.
487 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
489 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
490 AFS_TRACE_LEVEL_VERBOSE,
491 "AFSClose Decrement count on Fcb %p Cnt %d\n",
495 ASSERT( lCount >= 0);
500 case AFS_SPECIAL_SHARE_FCB:
503 AFSPipeOpenCloseRequestCB stPipeClose;
505 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
508 // Object the Parent ObjectInformationCB
511 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
514 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
515 &pObjectInfo->ParentFileId);
518 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
519 AFS_TRACE_LEVEL_VERBOSE,
520 "AFSClose Acquiring Special Share lock %p EXCL %08lX\n",
521 &pFcb->NPFcb->Resource,
522 PsGetCurrentThread());
524 AFSAcquireExcl( &pFcb->NPFcb->Resource,
527 RtlZeroMemory( &stPipeClose,
528 sizeof( AFSPipeOpenCloseRequestCB));
530 stPipeClose.RequestId = pCcb->RequestID;
532 stPipeClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
535 // Issue the open request to the service
539 AFSProcessRequest( AFS_REQUEST_TYPE_PIPE_CLOSE,
540 AFS_REQUEST_FLAG_SYNCHRONOUS,
542 &pDirCB->NameInformation.FileName,
544 (void *)&stPipeClose,
545 sizeof( AFSPipeOpenCloseRequestCB),
551 // Remove the Ccb and de-allocate it
558 // If this is not the root then decrement the open child reference count
561 if( pParentObjectInfo != NULL &&
562 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
565 lCount = InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
567 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
568 AFS_TRACE_LEVEL_VERBOSE,
569 "AFSClose (Share) Decrement child open ref count on Parent object %p Cnt %d\n",
574 AFSReleaseResource( &pFcb->NPFcb->Resource);
576 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
578 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
579 AFS_TRACE_LEVEL_VERBOSE,
580 "AFSClose (Share) Decrement count on Fcb %p Cnt %d\n",
584 ASSERT( lCount >= 0);
591 AFSDbgLogMsg( AFS_SUBSYSTEM_FILE_PROCESSING,
592 AFS_TRACE_LEVEL_ERROR,
593 "AFSClose Processing unknown node type %d\n",
594 pFcb->Header.NodeTypeCode);
602 // Complete the request
605 AFSCompleteRequest( Irp,
608 __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
613 "EXCEPTION - AFSClose\n");
615 AFSDumpTraceFilesFnc();
618 if ( pParentObjectInfo != NULL)
621 AFSReleaseObjectInfo( &pParentObjectInfo);