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,
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);
168 if( pParentObjectInfo != NULL &&
169 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
172 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
174 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
175 AFS_TRACE_LEVEL_VERBOSE,
176 "AFSClose (IOCtl) Decrement child open ref count on Parent object %p Cnt %d\n",
178 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
181 AFSReleaseResource( &pFcb->NPFcb->Resource);
183 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
185 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
186 AFS_TRACE_LEVEL_VERBOSE,
187 "AFSClose (IOCtl) Decrement count on Fcb %p Cnt %d\n",
191 ASSERT( lCount >= 0);
199 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
200 AFS_TRACE_LEVEL_VERBOSE,
201 "AFSClose Acquiring Special Root ALL lock %p EXCL %08lX\n",
202 &pFcb->NPFcb->Resource,
203 PsGetCurrentThread());
205 AFSAcquireExcl( &pFcb->NPFcb->Resource,
208 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
211 // Remove the Ccb and de-allocate it
217 AFSReleaseResource( &pFcb->NPFcb->Resource);
219 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
221 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
222 AFS_TRACE_LEVEL_VERBOSE,
223 "AFSClose (RootAll) Decrement count on Fcb %p Cnt %d\n",
227 ASSERT( lCount >= 0);
233 // Root, file or directory node
238 case AFS_DIRECTORY_FCB:
239 case AFS_SYMBOLIC_LINK_FCB:
240 case AFS_MOUNT_POINT_FCB:
241 case AFS_DFS_LINK_FCB:
242 case AFS_INVALID_FCB:
245 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
248 // We may be performing some cleanup on the Fcb so grab it exclusive to ensure no collisions
251 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
252 AFS_TRACE_LEVEL_VERBOSE,
253 "AFSClose Acquiring Dcb lock %p EXCL %08lX\n",
254 &pFcb->NPFcb->Resource,
255 PsGetCurrentThread());
257 AFSAcquireExcl( &pFcb->NPFcb->Resource,
260 KeQueryTickCount( &pFcb->ObjectInformation->LastAccessCount);
262 if( pFcb->OpenReferenceCount == 1 &&
263 pFcb->Header.NodeTypeCode == AFS_FILE_FCB)
266 SetFlag( pFcb->Flags, AFS_FCB_FILE_CLOSED);
269 // Attempt to tear down our extent list for the file
270 // If there are remaining dirty extents then attempt to
271 // flush them as well
274 if( pFcb->Specific.File.ExtentsDirtyCount)
277 AFSFlushExtents( pFcb,
282 // Wait for any outstanding queued flushes to complete
285 AFSWaitOnQueuedFlushes( pFcb);
287 ASSERT( pFcb->Specific.File.ExtentsDirtyCount == 0 &&
288 pFcb->Specific.File.QueuedFlushCount == 0);
290 AFSReleaseResource( &pFcb->NPFcb->Resource);
293 // Tear 'em down, we'll not be needing them again
296 AFSTearDownFcbExtents( pFcb,
302 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
303 pFcb->Specific.File.ExtentsDirtyCount &&
304 (pCcb->GrantedAccess & FILE_WRITE_DATA))
307 AFSFlushExtents( pFcb,
311 AFSReleaseResource( &pFcb->NPFcb->Resource);
314 pDirCB = pCcb->DirectoryCB;
317 // Steal the DirOpenReferenceCount from the Ccb
320 pCcb->DirectoryCB = NULL;
323 // Object the Parent ObjectInformationCB
326 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
329 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
330 &pObjectInfo->ParentFileId);
334 // Remove the Ccb and de-allocate it
341 // If this entry is deleted then remove the object from the volume tree
344 if( BooleanFlagOn( pDirCB->Flags, AFS_DIR_ENTRY_DELETED))
347 if( pFcb->Header.NodeTypeCode == AFS_FILE_FCB &&
348 pObjectInfo->Links == 0)
352 // Stop anything possibly in process
355 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
356 AFS_TRACE_LEVEL_VERBOSE,
357 "AFSClose Acquiring Fcb extents lock %p EXCL %08lX\n",
358 &pFcb->NPFcb->Specific.File.ExtentsResource,
359 PsGetCurrentThread());
361 AFSAcquireExcl( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource,
364 pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestStatus = STATUS_FILE_DELETED;
366 KeSetEvent( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsRequestComplete,
370 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
371 AFS_TRACE_LEVEL_VERBOSE,
372 "AFSClose Releasing Fcb extents lock %p EXCL %08lX\n",
373 &pFcb->NPFcb->Specific.File.ExtentsResource,
374 PsGetCurrentThread());
376 AFSReleaseResource( &pObjectInfo->Fcb->NPFcb->Specific.File.ExtentsResource);
379 ASSERT( pParentObjectInfo != NULL);
381 if ( pParentObjectInfo != NULL)
383 AFSAcquireExcl( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock,
386 AFSAcquireExcl( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock,
389 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
391 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
392 AFS_TRACE_LEVEL_VERBOSE,
393 "AFSClose (Other) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
394 &pDirCB->NameInformation.FileName,
399 ASSERT( lCount >= 0);
402 pDirCB->NameArrayReferenceCount <= 0)
405 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
406 AFS_TRACE_LEVEL_VERBOSE,
407 "AFSClose Deleting dir entry %p (%p) for %wZ FID %08lX-%08lX-%08lX-%08lX\n",
410 &pDirCB->NameInformation.FileName,
411 pObjectInfo->FileId.Cell,
412 pObjectInfo->FileId.Volume,
413 pObjectInfo->FileId.Vnode,
414 pObjectInfo->FileId.Unique);
417 // Remove and delete the directory entry from the parent list
420 AFSDeleteDirEntry( pParentObjectInfo,
423 AFSAcquireShared( &pObjectInfo->NonPagedInfo->ObjectInfoLock,
426 if( pObjectInfo->ObjectReferenceCount <= 0)
429 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE))
432 AFSDbgLogMsg( AFS_SUBSYSTEM_CLEANUP_PROCESSING,
433 AFS_TRACE_LEVEL_VERBOSE,
434 "AFSClose Removing object %p from volume tree\n",
437 AFSRemoveHashEntry( &pObjectInfo->VolumeCB->ObjectInfoTree.TreeHead,
438 &pObjectInfo->TreeEntry);
440 ClearFlag( pObjectInfo->Flags, AFS_OBJECT_INSERTED_HASH_TREE);
444 AFSReleaseResource( &pObjectInfo->NonPagedInfo->ObjectInfoLock);
447 AFSReleaseResource( pObjectInfo->VolumeCB->ObjectInfoTree.TreeLock);
449 AFSReleaseResource( pParentObjectInfo->Specific.Directory.DirectoryNodeHdr.TreeLock);
455 lCount = InterlockedDecrement( &pDirCB->DirOpenReferenceCount);
457 AFSDbgLogMsg( AFS_SUBSYSTEM_DIRENTRY_REF_COUNTING,
458 AFS_TRACE_LEVEL_VERBOSE,
459 "AFSClose (Other2) Decrement count on %wZ DE %p Ccb %p Cnt %d\n",
460 &pDirCB->NameInformation.FileName,
465 ASSERT( lCount >= 0);
469 // If this is not the root then decrement the open child reference count
472 if( pObjectInfo != NULL &&
473 pParentObjectInfo != NULL &&
474 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
477 InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
479 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
480 AFS_TRACE_LEVEL_VERBOSE,
481 "AFSClose Decrement child open ref count on Parent object %p Cnt %d\n",
483 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
487 // Decrement the reference count on the Fcb. this is protecting it from teardown.
490 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
492 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
493 AFS_TRACE_LEVEL_VERBOSE,
494 "AFSClose Decrement count on Fcb %p Cnt %d\n",
498 ASSERT( lCount >= 0);
503 case AFS_SPECIAL_SHARE_FCB:
506 AFSPipeOpenCloseRequestCB stPipeClose;
508 pCcb = (AFSCcb *)pIrpSp->FileObject->FsContext2;
511 // Object the Parent ObjectInformationCB
514 if( BooleanFlagOn( pObjectInfo->Flags, AFS_OBJECT_FLAGS_PARENT_FID))
517 pParentObjectInfo = AFSFindObjectInfo( pObjectInfo->VolumeCB,
518 &pObjectInfo->ParentFileId);
521 AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
522 AFS_TRACE_LEVEL_VERBOSE,
523 "AFSClose Acquiring Special Share lock %p EXCL %08lX\n",
524 &pFcb->NPFcb->Resource,
525 PsGetCurrentThread());
527 AFSAcquireExcl( &pFcb->NPFcb->Resource,
530 RtlZeroMemory( &stPipeClose,
531 sizeof( AFSPipeOpenCloseRequestCB));
533 stPipeClose.RequestId = pCcb->RequestID;
535 stPipeClose.RootId = pObjectInfo->VolumeCB->ObjectInformation.FileId;
538 // Issue the open request to the service
542 AFSProcessRequest( AFS_REQUEST_TYPE_PIPE_CLOSE,
543 AFS_REQUEST_FLAG_SYNCHRONOUS,
545 &pDirCB->NameInformation.FileName,
549 (void *)&stPipeClose,
550 sizeof( AFSPipeOpenCloseRequestCB),
556 // Remove the Ccb and de-allocate it
563 // If this is not the root then decrement the open child reference count
566 if( pParentObjectInfo != NULL &&
567 pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount > 0)
570 lCount = InterlockedDecrement( &pParentObjectInfo->Specific.Directory.ChildOpenReferenceCount);
572 AFSDbgLogMsg( AFS_SUBSYSTEM_OBJECT_REF_COUNTING,
573 AFS_TRACE_LEVEL_VERBOSE,
574 "AFSClose (Share) Decrement child open ref count on Parent object %p Cnt %d\n",
579 AFSReleaseResource( &pFcb->NPFcb->Resource);
581 lCount = InterlockedDecrement( &pFcb->OpenReferenceCount);
583 AFSDbgLogMsg( AFS_SUBSYSTEM_FCB_REF_COUNTING,
584 AFS_TRACE_LEVEL_VERBOSE,
585 "AFSClose (Share) Decrement count on Fcb %p Cnt %d\n",
589 ASSERT( lCount >= 0);
596 AFSDbgLogMsg( AFS_SUBSYSTEM_FILE_PROCESSING,
597 AFS_TRACE_LEVEL_ERROR,
598 "AFSClose Processing unknown node type %d\n",
599 pFcb->Header.NodeTypeCode);
607 // Complete the request
610 AFSCompleteRequest( Irp,
613 __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
618 "EXCEPTION - AFSClose\n");
620 AFSDumpTraceFilesFnc();
623 if ( pParentObjectInfo != NULL)
626 AFSReleaseObjectInfo( &pParentObjectInfo);