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     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
  60
  61     __try
  62     {
  63
  64         //
  65         // Set some initial variables to make processing easier
  66         //
  67
  68         if( DeviceObject == AFSDeviceObject)
  69         {
  70
  71             if( FlagOn( (ULONG_PTR)pIrpSp->FileObject->FsContext, AFS_CONTROL_INSTANCE))
  72             {
  73
  74                 //
  75                 // This is the process which was registered for the callback pool so cleanup the pool
  76                 //
  77
  78                 AFSCleanupIrpPool();
  79
  80                 //
  81                 // And reset the Service PID
  82                 //
  83                 AFSDeregisterService();
  84
  85             }
  86
  87             if( FlagOn( (ULONG_PTR)pIrpSp->FileObject->FsContext, AFS_REDIRECTOR_INSTANCE))
  88             {
  89
  90                 //
  91                 // Close the redirector
  92                 //
  93
  94                 AFSCloseRedirector();
  95             }
  96
  97             AFSCompleteRequest( Irp,
  98                                 ntStatus);
  99
 100             try_return( ntStatus);
 101         }
 102
 103         ntStatus = AFSCommonCleanup( DeviceObject,
 104                                      Irp);
 105
 106 try_exit:
 107
 108         NOTHING;
 109     }
 110     __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
 111     {
 112
 113         AFSDbgLogMsg( 0,
 114                       0,
 115                       "EXCEPTION - AFSCleanup\n");
 116
 117         AFSDumpTraceFilesFnc();
 118     }
 119
 120     return ntStatus;
 121 }
 122
 123 NTSTATUS
 124 AFSCommonCleanup( IN PDEVICE_OBJECT DeviceObject,
 125                   IN PIRP Irp)
 126 {
 127     UNREFERENCED_PARAMETER(DeviceObject);
 128     NTSTATUS ntStatus = STATUS_SUCCESS;
 129     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
 130     PFILE_OBJECT pFileObject = NULL;
 131     AFSDeviceExt *pControlDeviceExt = (AFSDeviceExt *)AFSDeviceObject->DeviceExtension;
 132     BOOLEAN bCompleteRequest = TRUE;
 133     AFSFcb* pFcb = NULL;
 134     __Enter
 135     {
 136
 137         //
 138         // Set some initial variables to make processing easier
 139         //
 140
 141         pFileObject = pIrpSp->FileObject;
 142
 143         pFcb = (AFSFcb*) pIrpSp->FileObject->FsContext;
 144
 145         if( pFcb == NULL ||
 146             pFcb->Header.NodeTypeCode == AFS_REDIRECTOR_FCB)
 147         {
 148
 149             //
 150             // Root open
 151             //
 152
 153             try_return( ntStatus);
 154         }
 155
 156         //
 157         // Check the state of the library
 158         //
 159
 160         ntStatus = AFSCheckLibraryState( Irp);
 161
 162         if( !NT_SUCCESS( ntStatus) ||
 163             ntStatus == STATUS_PENDING)
 164         {
 165
 166             if( ntStatus == STATUS_PENDING)
 167             {
 168                 bCompleteRequest = FALSE;
 169             }
 170
 171             try_return( ntStatus);
 172         }
 173
 174         bCompleteRequest = FALSE;
 175
 176         IoSkipCurrentIrpStackLocation( Irp);
 177
 178         ntStatus = IoCallDriver( pControlDeviceExt->Specific.Control.LibraryDeviceObject,
 179                                  Irp);
 180
 181         //
 182         // Indicate the library is done with the request
 183         //
 184
 185         AFSClearLibraryRequest();
 186
 187 try_exit:
 188
 189         if( bCompleteRequest)
 190         {
 191
 192             if( pFileObject != NULL)
 193             {
 194
 195                 //
 196                 // Setup the fileobject flags to indicate cleanup is complete.
 197                 //
 198
 199                 SetFlag( pFileObject->Flags, FO_CLEANUP_COMPLETE);
 200             }
 201
 202             //
 203             // Complete the request
 204             //
 205
 206             AFSCompleteRequest( Irp, ntStatus);
 207         }
 208     }
 209
 210     return ntStatus;
 211 }