Windows: Redirector opens must set a valid FsContext
[openafs.git] / 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( GetExceptionCode(), GetExceptionInformation()) )
106     {
107
108         AFSDbgLogMsg( 0,
109                       0,
110                       "EXCEPTION - AFSCleanup\n");
111     }
112
113     return ntStatus;
114 }
115
116 NTSTATUS
117 AFSCommonCleanup( IN PDEVICE_OBJECT DeviceObject,
118                   IN PIRP Irp)
119 {
120
121     NTSTATUS ntStatus = STATUS_SUCCESS;
122     AFSDeviceExt *pDeviceExt = (AFSDeviceExt *)DeviceObject->DeviceExtension;
123     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
124     PFILE_OBJECT pFileObject = NULL;
125     AFSDeviceExt *pControlDeviceExt = (AFSDeviceExt *)AFSDeviceObject->DeviceExtension;
126     BOOLEAN bCompleteRequest = TRUE;
127     AFSFcb* pFcb = NULL;
128     __Enter
129     {
130
131         //
132         // Set some initial variables to make processing easier
133         //
134
135         pFileObject = pIrpSp->FileObject;
136
137         pFcb = (AFSFcb*) pIrpSp->FileObject->FsContext;
138
139         if( pFcb == NULL ||
140             pFcb->Header.NodeTypeCode == AFS_REDIRECTOR_FCB)
141         {
142
143             //
144             // Root open
145             //
146
147             try_return( ntStatus);
148         }
149
150         //
151         // Check the state of the library
152         //
153
154         ntStatus = AFSCheckLibraryState( Irp);
155
156         if( !NT_SUCCESS( ntStatus) ||
157             ntStatus == STATUS_PENDING)
158         {
159
160             if( ntStatus == STATUS_PENDING)
161             {
162                 bCompleteRequest = FALSE;
163             }
164
165             try_return( ntStatus);
166         }
167
168         bCompleteRequest = FALSE;
169
170         IoSkipCurrentIrpStackLocation( Irp);
171
172         ntStatus = IoCallDriver( pControlDeviceExt->Specific.Control.LibraryDeviceObject,
173                                  Irp);
174
175         //
176         // Indicate the library is done with the request
177         //
178
179         AFSClearLibraryRequest();
180
181 try_exit:
182
183         if( bCompleteRequest)
184         {
185
186             if( pFileObject != NULL)
187             {
188
189                 //
190                 // Setup the fileobject flags to indicate cleanup is complete.
191                 //
192
193                 SetFlag( pFileObject->Flags, FO_CLEANUP_COMPLETE);
194             }
195
196             //
197             // Complete the request
198             //
199
200             AFSCompleteRequest( Irp, ntStatus);
201         }
202     }
203
204     return ntStatus;
205 }