summaryrefslogtreecommitdiffstats
path: root/private/ntos/cntfs/views/driver.c
blob: f1b24b06c1cd5d17615befc39012d45647ed7633 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
/*++

Copyright (c) 1989-1997  Microsoft Corporation

Module Name:

    driver.h

Abstract:

    This module contains the user FsCtls for the Ntfs Property support.


--*/

#include <viewprop.h>       //  needs propset.h and ntfsprop.h

#if defined( NTFSDBG ) || defined( DBG )
LONG NtfsDebugTraceIndent = 0;
LONG NtfsDebugTraceLevel = DEBUG_TRACE_PROP_FSCTL;
#endif

#define Dbg DEBUG_TRACE_PROP_FSCTL

//
//  DefaultEmptyProperty is used in place of any property that is truly not found
//

NOT_FOUND_PROPERTY DefaultEmptyProperty =
    { sizeof( DefaultEmptyProperty ),       //  PropertyValueLength
      PID_ILLEGAL,                          //  PropertyId
      0,                                    //  PropertyNameLength
      0,                                    //  PropertyName[0] (alignment pad when name length == 0)
      VT_EMPTY };                           //  dwType

LONGLONG Views0 = 0i64;


NTSTATUS
ViewFileSystemControl (
    IN PIRP_CONTEXT IrpContext,
    IN OBJECT_HANDLE Object,
    IN ATTRIBUTE_HANDLE Attribute,
    IN ULONG FsControlCode,
    IN ULONG InBufferLength,
    IN PVOID InBuffer,
    OUT PULONG OutBufferLength,
    OUT PVOID OutBuffer
    )

/*++

Routine Description:

    This routine dispatches the file system control call to workers within
    VIEWS.  This routines does not complete or post the IRP;  that function
    is reserved for the FsCtl dispatcher in Ntfs.

    Its job is to verify that the FsControlCode, the parameters and the buffers
    are appropriate.

Arguments:

    IrpContext - IrpContext for the call

    Object - FCB of the file where the View/Property call is directed
                                                              *
    Attribute - SCB of the property set stream.

    FsControlCode - Control code directing the action to take place

    InBufferLength - Length of the command buffer

    InBuffer - pointer to the unverified user command buffer.  All access
        to this needs to be wrapped in try/finally.

    OutBufferLength - pointer to ULONG length of output buffer.  This value
        is set on return to indicate the total size of data within the output
        buffer.

    OutBuffer - pointer to the unverified user command buffer.  All access
        to this needs to be wrapped in try/finally

Return Value:

    NTSTATUS - The return status for the operation

--*/

{
    NTSTATUS Status = STATUS_SUCCESS;
    PROPERTY_CONTEXT Context;

    DebugTrace( 0, Dbg, ("ViewFileSystemControl: IrpContext       %08x\n", IrpContext));
    DebugTrace( 0, Dbg, ("                       Object           %08x\n", Object));
    DebugTrace( 0, Dbg, ("                       Attribute        %08x\n", Attribute));
    DebugTrace( 0, Dbg, ("                       FsControlCode    %08x\n", FsControlCode));
    DebugTrace( 0, Dbg, ("                       InBufferLength   %08x\n", InBufferLength));
    DebugTrace( 0, Dbg, ("                       InBuffer         %08x\n", InBuffer));
    DebugTrace( 0, Dbg, ("                      *OutBufferLength  %08x\n", *OutBufferLength));
    DebugTrace( 0, Dbg, ("                       OutBuffer        %08x\n", OutBuffer));


    //
    //  Acquire object according to r/w needs of worker
    //

    switch (FsControlCode) {
    case FSCTL_READ_PROPERTY_DATA:
    case FSCTL_DUMP_PROPERTY_DATA:
        NtfsAcquireSharedScb( IrpContext, Attribute );
        break;

    case FSCTL_WRITE_PROPERTY_DATA:
    case FSCTL_INITIALIZE_PROPERTY_DATA:
        NtfsAcquireExclusiveScb( IrpContext, Attribute );
        break;
    default:
        return STATUS_INVALID_DEVICE_REQUEST;
    }

    if (!FlagOn( Attribute->ScbState, SCB_STATE_MODIFIED_NO_WRITE )) {

        DbgPrint( "Enabling NO_WRITE behaviour on stream\n" );
        SetFlag( Attribute->ScbState, SCB_STATE_MODIFIED_NO_WRITE );

    }


    try {

        //
        //  Make sure that the workers can map the stream
        //

        if (Attribute->FileObject == NULL) {
            NtfsCreateInternalAttributeStream( IrpContext, Attribute, FALSE );
        }

        //
        //  Set up context for workers.
        //

        InitializePropertyContext( &Context, IrpContext, Object, Attribute );


        //
        //  Verify that we have a property set to begin with
        //

        if (Attribute->AttributeTypeCode != $PROPERTY_SET) {
            ExRaiseStatus( STATUS_PROPSET_NOT_FOUND );
        }

        switch (FsControlCode) {
        case FSCTL_READ_PROPERTY_DATA:
            ReadPropertyData( &Context,
                              InBufferLength, InBuffer,
                              OutBufferLength, OutBuffer );
            break;

        case FSCTL_WRITE_PROPERTY_DATA:
            WritePropertyData( &Context,
                               InBufferLength, InBuffer,
                               OutBufferLength, OutBuffer );
            break;

        case FSCTL_INITIALIZE_PROPERTY_DATA:
            InitializePropertyData( &Context );
            break;

        case FSCTL_DUMP_PROPERTY_DATA:
            DumpPropertyData( &Context );
            break;

        }
    } except ( EXCEPTION_EXECUTE_HANDLER ) {
        //
        //  Remap the status code
        //

        Status = GetExceptionCode( );
        if (Status == STATUS_ACCESS_VIOLATION) {
            Status = STATUS_INVALID_USER_BUFFER;
        }
    }

    //
    //  Clean up any mapped context
    //

    CleanupPropertyContext( &Context );

    //
    //  Release Resource
    //

    NtfsReleaseScb( IrpContext, Attribute );

    if (Status != STATUS_SUCCESS) {
        ExRaiseStatus( Status );
    }

    DebugTrace( 0, Dbg, ("ViewFileSystemControl returned status %x, length %x\n", Status, *OutBufferLength) );

    return STATUS_SUCCESS;
}


/*++

Routine Description:

    This is the unload routine for the Views/properties file
    system device driver.  This routine deregisters with ntfs.

Arguments:

    DriverObject - Pointer to driver object created by the system.

Return Value:

    None.

--*/

VOID
DriverUnload (
    IN struct _DRIVER_OBJECT *DriverObject
    )
{
    NTSTATUS Status = NtOfsRegisterCallBacks( Views, NULL );

    UNREFERENCED_PARAMETER( DriverObject );

    DebugTrace( 0, Dbg, ("DriverUnload: NtOfsRegisterCallBacks returned %x\n", Status) );
}

/*++

Routine Description:

    This is the initialization routine for the Views/properties file
    system device driver.  This routine registers with ntfs and registers
    an unload routine.


Arguments:

    DriverObject - Pointer to driver object created by the system.

Return Value:

    NTSTATUS - The return status for the operation

--*/

VIEW_CALL_BACK ViewCallBackTable = {
    VIEW_CURRENT_INTERFACE_VERSION,
    ViewFileSystemControl
    };

NTSTATUS
DriverEntry (
    IN PDRIVER_OBJECT DriverObject,
    IN PUNICODE_STRING pstrRegistry
    )
{
    NTSTATUS Status;

    UNREFERENCED_PARAMETER( DriverObject );
    UNREFERENCED_PARAMETER( pstrRegistry );

    Status = NtOfsRegisterCallBacks( Views, &ViewCallBackTable );

    DriverObject->DriverUnload = DriverUnload;

    DbgPrint( "Ntfs views: Register call backs Status = 0x%lx\n", Status );
    return Status;
}


#if DBG == 1
PDRIVER_INITIALIZE pdi = DriverEntry;   // type check for changed prototype
#endif