src/WINNT/afsrdr/kernel/fs/AFSCleanup.cpp

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Kernel Drivers, LLC.
   3  * Copyright (c) 2009, 2010, 2011 Your File System, Inc.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  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,
  14  *   this list of conditions and the following disclaimer in the
  15  *   documentation
  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.
  21  *
  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.
  33  */
  34
  35 //
  36 // File: AFSCleanup.cpp
  37 //
  38
  39 #include "AFSCommon.h"
  40
  41 //
  42 // Function: AFSCleanup
  43 //
  44 // Description:
  45 //
  46 //      This function is the IRP_MJ_CLEANUP dispatch handler
  47 //
  48 // Return:
  49 //
  50 //       A status is returned for the handling of this request
  51 //
  52
  53 NTSTATUS
  54 AFSCleanup( IN PDEVICE_OBJECT DeviceObject,
  55             IN PIRP Irp)
  56 {
  57
  58     NTSTATUS ntStatus = STATUS_SUCCESS;
  59     AFSDeviceExt *pDeviceExt = (AFSDeviceExt *)DeviceObject->DeviceExtension;
  60     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
  61
  62     __try
  63     {
  64
  65         //
  66         // Set some initial variables to make processing easier
  67         //
  68
  69         if( DeviceObject == AFSDeviceObject)
  70         {
  71
  72             if( FlagOn( (ULONG_PTR)pIrpSp->FileObject->FsContext, AFS_CONTROL_INSTANCE))
  73             {
  74
  75                 //
  76                 // This is the process which was registered for the callback pool so cleanup the pool
  77                 //
  78
  79                 AFSCleanupIrpPool();
  80             }
  81
  82             if( FlagOn( (ULONG_PTR)pIrpSp->FileObject->FsContext, AFS_REDIRECTOR_INSTANCE))
  83             {
  84
  85                 //
  86                 // Close the redirector
  87                 //
  88
  89                 AFSCloseRedirector();
  90             }
  91
  92             AFSCompleteRequest( Irp,
  93                                 ntStatus);
  94
  95             try_return( ntStatus);
  96         }
  97
  98         ntStatus = AFSCommonCleanup( DeviceObject,
  99                                      Irp);
 100
 101 try_exit:
 102
 103         NOTHING;
 104     }
 105     __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
 106     {
 107
 108         AFSDbgLogMsg( 0,
 109                       0,
 110                       "EXCEPTION - AFSCleanup\n");
 111
 112         AFSDumpTraceFilesFnc();
 113     }
 114
 115     return ntStatus;
 116 }
 117
 118 NTSTATUS
 119 AFSCommonCleanup( IN PDEVICE_OBJECT DeviceObject,
 120                   IN PIRP Irp)
 121 {
 122
 123     NTSTATUS ntStatus = STATUS_SUCCESS;
 124     AFSDeviceExt *pDeviceExt = (AFSDeviceExt *)DeviceObject->DeviceExtension;
 125     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
 126     PFILE_OBJECT pFileObject = NULL;
 127     AFSDeviceExt *pControlDeviceExt = (AFSDeviceExt *)AFSDeviceObject->DeviceExtension;
 128     BOOLEAN bCompleteRequest = TRUE;
 129     AFSFcb* pFcb = NULL;
 130     __Enter
 131     {
 132
 133         //
 134         // Set some initial variables to make processing easier
 135         //
 136
 137         pFileObject = pIrpSp->FileObject;
 138
 139         pFcb = (AFSFcb*) pIrpSp->FileObject->FsContext;
 140
 141         if( pFcb == NULL ||
 142             pFcb->Header.NodeTypeCode == AFS_REDIRECTOR_FCB)
 143         {
 144
 145             //
 146             // Root open
 147             //
 148
 149             try_return( ntStatus);
 150         }
 151
 152         //
 153         // Check the state of the library
 154         //
 155
 156         ntStatus = AFSCheckLibraryState( Irp);
 157
 158         if( !NT_SUCCESS( ntStatus) ||
 159             ntStatus == STATUS_PENDING)
 160         {
 161
 162             if( ntStatus == STATUS_PENDING)
 163             {
 164                 bCompleteRequest = FALSE;
 165             }
 166
 167             try_return( ntStatus);
 168         }
 169
 170         bCompleteRequest = FALSE;
 171
 172         IoSkipCurrentIrpStackLocation( Irp);
 173
 174         ntStatus = IoCallDriver( pControlDeviceExt->Specific.Control.LibraryDeviceObject,
 175                                  Irp);
 176
 177         //
 178         // Indicate the library is done with the request
 179         //
 180
 181         AFSClearLibraryRequest();
 182
 183 try_exit:
 184
 185         if( bCompleteRequest)
 186         {
 187
 188             if( pFileObject != NULL)
 189             {
 190
 191                 //
 192                 // Setup the fileobject flags to indicate cleanup is complete.
 193                 //
 194
 195                 SetFlag( pFileObject->Flags, FO_CLEANUP_COMPLETE);
 196             }
 197
 198             //
 199             // Complete the request
 200             //
 201
 202             AFSCompleteRequest( Irp, ntStatus);
 203         }
 204     }
 205
 206     return ntStatus;
 207 }