src/WINNT/afsrdr/kernel/lib/AFSFlushBuffers.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: AFSFlushBuffers.cpp
  37 //
  38
  39 #include "AFSCommon.h"
  40
  41 NTSTATUS
  42 AFSFlushBuffers( IN PDEVICE_OBJECT LibDeviceObject,
  43                  IN PIRP Irp)
  44 {
  45
  46     NTSTATUS           ntStatus = STATUS_SUCCESS;
  47     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
  48     PFILE_OBJECT       pFileObject = pIrpSp->FileObject;
  49     AFSFcb            *pFcb = (AFSFcb *)pFileObject->FsContext;
  50     AFSCcb            *pCcb = (AFSCcb *)pFileObject->FsContext2;
  51     IO_STATUS_BLOCK    iosb = {0};
  52     BOOLEAN            bReleaseSectionObject = FALSE;
  53
  54     pIrpSp = IoGetCurrentIrpStackLocation( Irp);
  55
  56     __Enter
  57     {
  58
  59         if( pFcb == NULL)
  60         {
  61
  62             AFSDbgLogMsg( AFS_SUBSYSTEM_FILE_PROCESSING,
  63                           AFS_TRACE_LEVEL_ERROR,
  64                           "AFSFlushBuffers Attempted access (%08lX) when pFcb == NULL\n",
  65                           Irp);
  66
  67             try_return( ntStatus = STATUS_INVALID_DEVICE_REQUEST);
  68         }
  69
  70         if( pFcb->Header.NodeTypeCode == AFS_ROOT_FCB ||
  71             pFcb->Header.NodeTypeCode == AFS_ROOT_ALL )
  72         {
  73
  74             //
  75             // Once we support ADS's on directories we need to perform a flush ehre
  76             //
  77
  78             try_return( ntStatus = STATUS_SUCCESS);
  79
  80         }
  81         else if (pFcb->Header.NodeTypeCode != AFS_FILE_FCB)
  82         {
  83             //
  84             // Nothing to flush Everything but files are write through
  85             //
  86             try_return( ntStatus = STATUS_INVALID_PARAMETER);
  87         }
  88
  89         AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
  90                       AFS_TRACE_LEVEL_VERBOSE,
  91                       "AFSFlushBuffers Acquiring Fcb SectionObject lock %08lX SHARED %08lX\n",
  92                       &pFcb->NPFcb->SectionObjectResource,
  93                       PsGetCurrentThread());
  94
  95         AFSAcquireShared( &pFcb->NPFcb->SectionObjectResource,
  96                           TRUE);
  97
  98         bReleaseSectionObject = TRUE;
  99
 100         //
 101         // The flush consists of two parts.  We firstly flush our
 102         // cache (if we have one), then we tell the service to write
 103         // to the remote server
 104         //
 105         __try
 106         {
 107
 108             CcFlushCache( &pFcb->NPFcb->SectionObjectPointers, NULL, 0, &iosb);
 109
 110             if (!NT_SUCCESS( iosb.Status ))
 111             {
 112
 113                 AFSDbgLogMsg( AFS_SUBSYSTEM_IO_PROCESSING,
 114                               AFS_TRACE_LEVEL_ERROR,
 115                               "AFSFlushBuffers CcFlushCache [1] failure FID %08lX-%08lX-%08lX-%08lX Status 0x%08lX Bytes 0x%08lX\n",
 116                               pFcb->ObjectInformation->FileId.Cell,
 117                               pFcb->ObjectInformation->FileId.Volume,
 118                               pFcb->ObjectInformation->FileId.Vnode,
 119                               pFcb->ObjectInformation->FileId.Unique,
 120                               iosb.Status,
 121                               iosb.Information);
 122
 123                 try_return( ntStatus = iosb.Status );
 124             }
 125         }
 126         __except( EXCEPTION_EXECUTE_HANDLER)
 127         {
 128
 129             try_return( ntStatus = GetExceptionCode());
 130         }
 131
 132         AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
 133                       AFS_TRACE_LEVEL_VERBOSE,
 134                       "AFSFlushBuffers Releasing Fcb SectionObject lock %08lX SHARED %08lX\n",
 135                       &pFcb->NPFcb->SectionObjectResource,
 136                       PsGetCurrentThread());
 137
 138         AFSReleaseResource( &pFcb->NPFcb->SectionObjectResource);
 139
 140         bReleaseSectionObject = FALSE;
 141
 142         //
 143         // Now, flush to the server - if there is stuff to do
 144         //
 145
 146         ntStatus = AFSFlushExtents( pFcb,
 147                                     &pCcb->AuthGroup);
 148
 149         if( !NT_SUCCESS( ntStatus))
 150         {
 151
 152             AFSReleaseExtentsWithFlush( pFcb,
 153                                         &pCcb->AuthGroup,
 154                                         TRUE);
 155
 156             ntStatus = STATUS_SUCCESS;
 157         }
 158
 159 try_exit:
 160
 161         if ( bReleaseSectionObject)
 162         {
 163
 164             AFSDbgLogMsg( AFS_SUBSYSTEM_LOCK_PROCESSING,
 165                           AFS_TRACE_LEVEL_VERBOSE,
 166                           "AFSFlushBuffers Releasing Fcb SectionObject lock %08lX SHARED %08lX\n",
 167                           &pFcb->NPFcb->SectionObjectResource,
 168                           PsGetCurrentThread());
 169
 170             AFSReleaseResource( &pFcb->NPFcb->SectionObjectResource);
 171         }
 172
 173         AFSCompleteRequest( Irp, ntStatus);
 174     }
 175
 176     return ntStatus;
 177 }