Windows: RDR File System Framework driver
[openafs.git] / src / WINNT / afsrdr / kernel / fs / AFSClose.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: AFSClose.cpp
37 //
38
39 #include "AFSCommon.h"
40
41 //
42 // Function: AFSClose
43 //
44 // Description:
45 //
46 //      This function is the IRP_MJ_CLOSE dispatch handler
47 //
48 // Return:
49 //
50 //       A status is returned for the handling of this request
51 //
52
53 NTSTATUS
54 AFSClose( IN PDEVICE_OBJECT DeviceObject,
55           IN PIRP Irp)
56 {
57
58     NTSTATUS ntStatus = STATUS_SUCCESS;
59
60     __try
61     {
62
63         if( DeviceObject == AFSDeviceObject)
64         {
65
66             AFSCompleteRequest( Irp,
67                                 ntStatus);
68
69             try_return( ntStatus);
70         }
71
72         ntStatus = AFSCommonClose( DeviceObject,
73                                    Irp);
74
75 try_exit:
76
77         NOTHING;
78     }
79     __except( AFSExceptionFilter( GetExceptionCode(), GetExceptionInformation()) )
80     {
81
82         AFSDbgLogMsg( 0,
83                       0,
84                       "EXCEPTION - AFSClose\n");
85     }
86
87     return ntStatus;
88 }
89
90 NTSTATUS
91 AFSCommonClose( IN PDEVICE_OBJECT DeviceObject,
92                 IN PIRP Irp)
93 {
94
95     NTSTATUS ntStatus = STATUS_SUCCESS;
96     ULONG ulRequestType = 0;
97     IO_STACK_LOCATION *pIrpSp = IoGetCurrentIrpStackLocation( Irp);
98     AFSDeviceExt *pDeviceExt = NULL;
99     AFSDeviceExt *pControlDeviceExt = (AFSDeviceExt *)AFSDeviceObject->DeviceExtension;
100
101     __Enter
102     {
103
104         pDeviceExt = (AFSDeviceExt *)DeviceObject->DeviceExtension;
105
106         pIrpSp = IoGetCurrentIrpStackLocation( Irp);
107
108         if( pIrpSp->FileObject->FsContext == NULL)
109         {
110
111             AFSCompleteRequest( Irp, ntStatus);
112
113             try_return( ntStatus);
114         }
115
116         //
117         // Check the state of the library
118         //
119
120         ntStatus = AFSCheckLibraryState( Irp);
121
122         if( !NT_SUCCESS( ntStatus) ||
123             ntStatus == STATUS_PENDING)
124         {
125
126             if( ntStatus != STATUS_PENDING)
127             {
128                 AFSCompleteRequest( Irp, ntStatus);
129             }
130
131             try_return( ntStatus);
132         }
133
134         IoSkipCurrentIrpStackLocation( Irp);
135
136         ntStatus = IoCallDriver( pControlDeviceExt->Specific.Control.LibraryDeviceObject,
137                                  Irp);
138
139         //
140         // Indicate the library is done with the request
141         //
142
143         AFSClearLibraryRequest();
144
145 try_exit:
146
147         NOTHING;
148     }
149
150     return ntStatus;
151 }