src/WINNT/afsrdr/kernel/fs/AFSWrite.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: AFSWrite.cpp
  37 //
  38
  39 #include "AFSCommon.h"
  40
  41
  42 static
  43 NTSTATUS
  44 AFSWriteComplete( IN PDEVICE_OBJECT DeviceObject,
  45                   IN PIRP Irp,
  46                   IN PVOID Contxt);
  47
  48 //
  49 // Function: AFSWrite
  50 //
  51 // Description:
  52 //
  53 //      This is the dispatch handler for the IRP_MJ_WRITE request.  Since we want to
  54 //      allow the library to pend the write we need to lock the library for the
  55 //      duration of the thread calling the library but also for the life of the IRP.
  56 //      So this code path establishes an IO completion function.
  57 //
  58 // Return:
  59 //
  60 //      A status is returned for the function
  61 //
  62
  63 NTSTATUS
  64 AFSWrite( IN PDEVICE_OBJECT DeviceObject,
  65           IN PIRP Irp)
  66 {
  67
  68     NTSTATUS ntStatus = STATUS_SUCCESS;
  69     AFSDeviceExt *pControlDeviceExt = (AFSDeviceExt *)AFSDeviceObject->DeviceExtension;
  70
  71     __try
  72     {
  73
  74         if( DeviceObject == AFSDeviceObject)
  75         {
  76
  77             ntStatus = STATUS_INVALID_DEVICE_REQUEST;
  78
  79             AFSCompleteRequest( Irp,
  80                                 ntStatus);
  81
  82             try_return( ntStatus);
  83         }
  84
  85         //
  86         // Check the state of the library
  87         //
  88
  89         ntStatus = AFSCheckLibraryState( Irp);
  90
  91         if( !NT_SUCCESS( ntStatus) ||
  92             ntStatus == STATUS_PENDING)
  93         {
  94
  95             if( ntStatus != STATUS_PENDING)
  96             {
  97
  98                 AFSCompleteRequest( Irp, ntStatus);
  99             }
 100
 101             try_return( ntStatus);
 102         }
 103
 104         //
 105         // Increment the outstanding IO count again - this time for the
 106         // completion routine.
 107         //
 108
 109         ntStatus = AFSCheckLibraryState( Irp);
 110
 111         if( !NT_SUCCESS( ntStatus) ||
 112             ntStatus == STATUS_PENDING)
 113         {
 114
 115             AFSClearLibraryRequest();
 116
 117             if( ntStatus != STATUS_PENDING)
 118             {
 119
 120                 AFSCompleteRequest( Irp, ntStatus);
 121             }
 122
 123             try_return( ntStatus);
 124         }
 125
 126         //
 127         // And send it down, but arrange to capture the comletion
 128         // so we can free our lock against unloading.
 129         //
 130
 131         IoCopyCurrentIrpStackLocationToNext( Irp);
 132
 133         AFSDbgTrace(( AFS_SUBSYSTEM_IO_PROCESSING,
 134                       AFS_TRACE_LEVEL_VERBOSE,
 135                       "Setting AFSWriteComplete as IoCompletion Routine Irp %p\n",
 136                       Irp));
 137
 138         IoSetCompletionRoutine( Irp, AFSWriteComplete, NULL, TRUE, TRUE, TRUE);
 139
 140         ntStatus = IoCallDriver( pControlDeviceExt->Specific.Control.LibraryDeviceObject,
 141                                  Irp);
 142
 143         //
 144         // Indicate the library/thread pair is done with the request
 145         //
 146
 147         AFSClearLibraryRequest();
 148
 149 try_exit:
 150
 151         NOTHING;
 152     }
 153     __except( AFSExceptionFilter( __FUNCTION__, GetExceptionCode(), GetExceptionInformation()) )
 154     {
 155
 156         ntStatus = STATUS_INSUFFICIENT_RESOURCES;
 157
 158         AFSDumpTraceFilesFnc();
 159     }
 160
 161     return ntStatus;
 162 }
 163
 164 //
 165 // AFSWriteComplete
 166 //
 167 static
 168 NTSTATUS
 169 AFSWriteComplete( IN PDEVICE_OBJECT DeviceObject,
 170                   IN PIRP Irp,
 171                   IN PVOID Context)
 172 {
 173     UNREFERENCED_PARAMETER(DeviceObject);
 174     UNREFERENCED_PARAMETER(Irp);
 175     UNREFERENCED_PARAMETER(Context);
 176     BOOLEAN bPending = FALSE;
 177
 178     //
 179     // Indicate the library/IRP pair is done with the request
 180     //
 181
 182     AFSClearLibraryRequest();
 183
 184     if (Irp->PendingReturned) {
 185
 186         bPending = TRUE;
 187
 188         IoMarkIrpPending(Irp);
 189     }
 190
 191     AFSDbgTrace(( AFS_SUBSYSTEM_IO_PROCESSING,
 192                   AFS_TRACE_LEVEL_VERBOSE,
 193                   "AFSWriteComplete Irp %p%s\n",
 194                   Irp,
 195                   bPending ? " PENDING" : ""));
 196
 197     return STATUS_CONTINUE_COMPLETION;
 198 }