Sample Code

windows driver samples/ cdfs file system driver/ C++/ close.c/

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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
/*++
 
Copyright (c) 1989-2000 Microsoft Corporation
 
Module Name:
 
    Close.c
 
Abstract:
 
    This module implements the File Close routine for Cdfs called by the
    Fsd/Fsp dispatch routines.
 
    The close operation interacts with both the async and delayed close queues
    in the CdData structure.  Since close may be called recursively we may
    violate the locking order in acquiring the Vcb or Fcb.  In this case
    we may move the request to the async close queue.  If this is the last
    reference on the Fcb and there is a chance the user may reopen this
    file again soon we would like to defer the close.  In this case we
    may move the request to the async close queue.
 
    Once we are past the decode file operation there is no need for the
    file object.  If we are moving the request to either of the work
    queues then we remember all of the information from the file object and
    complete the request with STATUS_SUCCESS.  The Io system can then
    reuse the file object and we can complete the request when convenient.
 
    The async close queue consists of requests which we would like to
    complete as soon as possible.  They are queued using the original
    IrpContext where some of the fields have been overwritten with
    information from the file object.  We will extract this information,
    cleanup the IrpContext and then call the close worker routine.
 
    The delayed close queue consists of requests which we would like to
    defer the close for.  We keep size of this list within a range
    determined by the size of the system.  We let it grow to some maximum
    value and then shrink to some minimum value.  We allocate a small
    structure which contains the key information from the file object
    and use this information along with an IrpContext on the stack
    to complete the request.
 
 
--*/
 
#include "CdProcs.h"
 
//
//  The Bug check file id for this module
//
 
#define BugCheckFileId                   (CDFS_BUG_CHECK_CLOSE)
 
//
//  Local support routines
//
 
_Requires_lock_held_(_Global_critical_region_)
BOOLEAN
CdCommonClosePrivate (
    _In_ PIRP_CONTEXT IrpContext,
    _In_ PVCB Vcb,
    _In_ PFCB Fcb,
    _In_ ULONG UserReference,
    _In_ BOOLEAN FromFsd
    );
 
VOID
CdQueueClose (
    _In_ PIRP_CONTEXT IrpContext,
    _In_ PFCB Fcb,
    _In_ ULONG UserReference,
    _In_ BOOLEAN DelayedClose
    );
 
PIRP_CONTEXT
CdRemoveClose (
    _In_opt_ PVCB Vcb
    );
 
//  Tell prefast this is a workitem routine
IO_WORKITEM_ROUTINE CdCloseWorker;
 
VOID
CdCloseWorker (
    _In_ PDEVICE_OBJECT DeviceObject,
    _In_opt_ PVOID Context
    );
 
#ifdef ALLOC_PRAGMA
#pragma alloc_text(PAGE, CdFspClose)
#pragma alloc_text(PAGE, CdCommonClose)
#pragma alloc_text(PAGE, CdCommonClosePrivate)
#pragma alloc_text(PAGE, CdQueueClose)
#pragma alloc_text(PAGE, CdRemoveClose)
#pragma alloc_text(PAGE, CdCloseWorker)
#endif
 
 
VOID
CdFspClose (
    _In_opt_ PVCB Vcb
    )
 
/*++
 
Routine Description:
 
    This routine is called to process the close queues in the CdData.  If the
    Vcb is passed then we want to remove all of the closes for this Vcb.
    Otherwise we will do as many of the delayed closes as we need to do.
 
Arguments:
 
    Vcb - If specified then we are looking for all of the closes for the
        given Vcb.
 
Return Value:
 
    None
 
--*/
 
{
    PIRP_CONTEXT IrpContext;
    IRP_CONTEXT StackIrpContext;
 
    THREAD_CONTEXT ThreadContext = {0};
 
    PFCB Fcb;
    ULONG UserReference;
 
    ULONG VcbHoldCount = 0;
    PVCB CurrentVcb = NULL;
 
    BOOLEAN PotentialVcbTeardown = FALSE;
 
    PAGED_CODE();
 
    FsRtlEnterFileSystem();
 
    //
    //  Continue processing until there are no more closes to process.
    //
 
    while ((IrpContext = CdRemoveClose( Vcb )) != NULL) {
 
        //
        //  If we don't have an IrpContext then use the one on the stack.
        //  Initialize it for this request.
        //
 
        if (SafeNodeType( IrpContext ) != CDFS_NTC_IRP_CONTEXT ) {
 
            //
            //  Update the local values from the IrpContextLite.
            //
 
            Fcb = ((PIRP_CONTEXT_LITE) IrpContext)->Fcb;
            UserReference = ((PIRP_CONTEXT_LITE) IrpContext)->UserReference;
 
            //
            //  Update the stack irp context with the values from the
            //  IrpContextLite.
            //
 
            CdInitializeStackIrpContext( &StackIrpContext,
                                         (PIRP_CONTEXT_LITE) IrpContext );
 
            //
            //  Free the IrpContextLite.
            //
 
            CdFreeIrpContextLite( (PIRP_CONTEXT_LITE) IrpContext );
 
            //
            //  Remember we have the IrpContext from the stack.
            //
 
            IrpContext = &StackIrpContext;
 
        //
        //  Otherwise cleanup the existing IrpContext.
        //
 
        } else {
 
            //
            //  Remember the Fcb and user reference count.
            //
 
            Fcb = (PFCB) IrpContext->Irp;
            IrpContext->Irp = NULL;
 
            UserReference = (ULONG) IrpContext->ExceptionStatus;
            IrpContext->ExceptionStatus = STATUS_SUCCESS;
        }
 
        _Analysis_assume_(Fcb != NULL && Fcb->Vcb != NULL);
 
        //
        //  We have an IrpContext.  Now we need to set the top level thread
        //  context.
        //
 
        SetFlag( IrpContext->Flags, IRP_CONTEXT_FSP_FLAGS );
 
        //
        //  If we were given a Vcb then there is a request on top of this.
        //
 
        if (ARGUMENT_PRESENT( Vcb )) {
 
            ClearFlag( IrpContext->Flags,
                       IRP_CONTEXT_FLAG_TOP_LEVEL | IRP_CONTEXT_FLAG_TOP_LEVEL_CDFS );
        }
 
        CdSetThreadContext( IrpContext, &ThreadContext );
 
        //
        //  If we have hit the maximum number of requests to process without
        //  releasing the Vcb then release the Vcb now.  If we are holding
        //  a different Vcb to this one then release the previous Vcb.
        //
        //  In either case acquire the current Vcb.
        //
        //  We use the MinDelayedCloseCount from the CdData since it is
        //  a convenient value based on the system size.  Only thing we are trying
        //  to do here is prevent this routine starving other threads which
        //  may need this Vcb exclusively.
        //
        //  Note that the check for potential teardown below is unsafe.  We'll
        //  repeat later within the cddata lock.
        //
 
        PotentialVcbTeardown = !ARGUMENT_PRESENT( Vcb ) &&
                               (Fcb->Vcb->VcbCondition != VcbMounted) &&
                               (Fcb->Vcb->VcbCondition != VcbMountInProgress) &&
                               (Fcb->Vcb->VcbCleanup == 0);
 
        if (PotentialVcbTeardown ||
            (VcbHoldCount > CdData.MinDelayedCloseCount) ||
            (Fcb->Vcb != CurrentVcb)) {
 
            if (CurrentVcb != NULL) {
 
                CdReleaseVcb( IrpContext, CurrentVcb );
            }
 
            if (PotentialVcbTeardown) {
 
                CdAcquireCdData( IrpContext );
 
                //
                //  Repeat the checks with global lock held.  The volume could have
                //  been remounted while we didn't hold the lock.
                //
 
                PotentialVcbTeardown = !ARGUMENT_PRESENT( Vcb ) &&
                                       (Fcb->Vcb->VcbCondition != VcbMounted) &&
                                       (Fcb->Vcb->VcbCondition != VcbMountInProgress) &&
                                       (Fcb->Vcb->VcbCleanup == 0);
                                 
                if (!PotentialVcbTeardown)  {
 
                    CdReleaseCdData( IrpContext);
                }
            }
 
            CurrentVcb = Fcb->Vcb;
 
            _Analysis_assume_( CurrentVcb != NULL );
             
            CdAcquireVcbShared( IrpContext, CurrentVcb, FALSE );
 
            VcbHoldCount = 0;
 
        } else {
 
            VcbHoldCount += 1;
        }
 
        //
        //  Call our worker routine to perform the close operation.
        //
 
        CdCommonClosePrivate( IrpContext, CurrentVcb, Fcb, UserReference, FALSE );
 
        //
        //  If the reference count on this Vcb is below our residual reference
        //  then check if we should dismount the volume.
        //
 
        if (PotentialVcbTeardown) {
 
            CdReleaseVcb( IrpContext, CurrentVcb );
            CdCheckForDismount( IrpContext, CurrentVcb, FALSE );
 
            CurrentVcb = NULL;
 
            CdReleaseCdData( IrpContext );
            PotentialVcbTeardown = FALSE;
        }
 
        //
        //  Complete the current request to cleanup the IrpContext.
        //
 
        CdCompleteRequest( IrpContext, NULL, STATUS_SUCCESS );
    }
 
    //
    //  Release any Vcb we may still hold.
    //
 
    if (CurrentVcb != NULL) {
 
        CdReleaseVcb( IrpContext, CurrentVcb );
 
    }
 
#pragma prefast(suppress:26165, "Esp:1153")
    FsRtlExitFileSystem();
}
 
_Requires_lock_held_(_Global_critical_region_)
NTSTATUS
CdCommonClose (
    _Inout_ PIRP_CONTEXT IrpContext,
    _Inout_ PIRP Irp
    )
 
/*++
 
Routine Description:
 
    This routine is the Fsd entry for the close operation.  We decode the file
    object to find the CDFS structures and type of open.  We call our internal
    worker routine to perform the actual work.  If the work wasn't completed
    then we post to one of our worker queues.  The Ccb isn't needed after this
    point so we delete the Ccb and return STATUS_SUCCESS to our caller in all
    cases.
 
Arguments:
 
    Irp - Supplies the Irp to process
 
Return Value:
 
    STATUS_SUCCESS
 
--*/
 
{
    TYPE_OF_OPEN TypeOfOpen;
 
    PVCB Vcb;
    PFCB Fcb;
    PCCB Ccb;
    ULONG UserReference = 0;
 
    BOOLEAN PotentialVcbTeardown = FALSE;
 
    PAGED_CODE();
 
    ASSERT_IRP_CONTEXT( IrpContext );
    ASSERT_IRP( Irp );
 
    //
    //  If we were called with our file system device object instead of a
    //  volume device object, just complete this request with STATUS_SUCCESS.
    //
 
    if (IrpContext->Vcb == NULL) {
 
        CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
        return STATUS_SUCCESS;
    }
 
    //
    //  Decode the file object to get the type of open and Fcb/Ccb.
    //
 
    TypeOfOpen = CdDecodeFileObject( IrpContext,
                                     IoGetCurrentIrpStackLocation( Irp )->FileObject,
                                     &Fcb,
                                     &Ccb );
 
    //
    //  No work to do for unopened file objects.
    //
 
    if (TypeOfOpen == UnopenedFileObject) {
 
        CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
 
        return STATUS_SUCCESS;
    }
 
    Vcb = Fcb->Vcb;
 
    //
    //  Clean up any CCB associated with this open.
    //
     
    if (Ccb != NULL) {
 
        UserReference = 1;
 
        //
        //  We can always deallocate the Ccb if present.
        //
 
        CdDeleteCcb( IrpContext, Ccb );
    }
 
    //
    //  If this is the last reference to a user file or directory on a
    //  currently mounted volume, then post it to the delayed close queue.  Note
    //  that the VcbCondition check is unsafe,  but it doesn't really matter -
    //  we just might delay the volume teardown a little by posting this close.
    //
 
    if ((Vcb->VcbCondition == VcbMounted) &&
        (Fcb->FcbReference == 1) &&
        ((TypeOfOpen == UserFileOpen) ||
         (TypeOfOpen == UserDirectoryOpen))) {
 
        CdQueueClose( IrpContext, Fcb, UserReference, TRUE );
        IrpContext = NULL;
 
    //
    //  Otherwise try to process this close.  Post to the async close queue
    //  if we can't acquire all of the resources.
    //
 
    }
    else {
 
        //
        //  If we may be dismounting this volume then acquire the CdData
        //  resource.
        //
        //  Since we now must make volumes go away as soon as reasonable after
        //  the last user handles closes, key off of the cleanup count.  It is
        //  OK to do this more than neccesary.  Since this Fcb could be holding
        //  a number of other Fcbs (and thus their references), a simple check
        //  on reference count is not appropriate.
        //
        //  Do an unsafe check first to avoid taking the (global) cddata lock in the
        //  common case.
        //
 
        if ((Vcb->VcbCleanup == 0) &&
            (Vcb->VcbCondition != VcbMounted))  {
 
            //
            //  Possible dismount.  Acquire CdData to synchronise with the remount path
            //  before looking at the vcb condition again.
            //
 
            CdAcquireCdData( IrpContext );
 
            if ((Vcb->VcbCleanup == 0) &&
                (Vcb->VcbCondition != VcbMounted) &&
                (Vcb->VcbCondition != VcbMountInProgress) &&
                FlagOn( IrpContext->Flags, IRP_CONTEXT_FLAG_TOP_LEVEL_CDFS ))  {
 
                PotentialVcbTeardown = TRUE;
            }
            else {
 
                //
                //  We can't dismount this volume now,  there are other references or
                //  it's just been remounted.
                //
            }
 
            //
            //  Drop the global lock if we don't need it anymore.
            //
 
            if (!PotentialVcbTeardown) {
 
                CdReleaseCdData( IrpContext );
            }
        }
         
        //
        //  Call the worker routine to perform the actual work.  This routine
        //  should never raise except for a fatal error.
        //
 
        if (!CdCommonClosePrivate( IrpContext, Vcb, Fcb, UserReference, TRUE )) {
 
            //
            //  If we didn't complete the request then post the request as needed.
            //
 
            CdQueueClose( IrpContext, Fcb, UserReference, FALSE );
            IrpContext = NULL;
 
        //
        //  Check whether we should be dismounting the volume and then complete
        //  the request.
        //
 
        }
        else if (PotentialVcbTeardown) {
 
            CdCheckForDismount( IrpContext, Vcb, FALSE );
        }
    }
 
    //
    //  Always complete this request with STATUS_SUCCESS.
    //
 
    CdCompleteRequest( IrpContext, Irp, STATUS_SUCCESS );
 
    if (PotentialVcbTeardown) {
 
        CdReleaseCdData( IrpContext );
    }
 
    //
    //  Always return STATUS_SUCCESS for closes.
    //
 
    return STATUS_SUCCESS;
}
 
//
//  Local support routine
//
 
_Requires_lock_held_(_Global_critical_region_)
BOOLEAN
CdCommonClosePrivate (
    _In_ PIRP_CONTEXT IrpContext,
    _In_ PVCB Vcb,
    _In_ PFCB Fcb,
    _In_ ULONG UserReference,
    _In_ BOOLEAN FromFsd
    )
 
/*++
 
Routine Description:
 
    This is the worker routine for the close operation.  We can be called in
    an Fsd thread or from a worker Fsp thread.  If called from the Fsd thread
    then we acquire the resources without waiting.  Otherwise we know it is
    safe to wait.
 
    We check to see whether we should post this request to the delayed close
    queue.  If we are to process the close here then we acquire the Vcb and
    Fcb.  We will adjust the counts and call our teardown routine to see
    if any of the structures should go away.
 
Arguments:
 
    Vcb - Vcb for this volume.
 
    Fcb - Fcb for this request.
 
    UserReference - Number of user references for this file object.  This is
        zero for an internal stream.
 
    FromFsd - This request was called from an Fsd thread.  Indicates whether
        we should wait to acquire resources.
 
    DelayedClose - Address to store whether we should try to put this on
        the delayed close queue.  Ignored if this routine can process this
        close.
 
Return Value:
 
    BOOLEAN - TRUE if this thread processed the close, FALSE otherwise.
 
--*/
 
{
    BOOLEAN RemovedFcb;
 
    PAGED_CODE();
 
    ASSERT_IRP_CONTEXT( IrpContext );
    ASSERT_FCB( Fcb );
 
    //
    //  Try to acquire the Vcb and Fcb.  If we can't acquire them then return
    //  and let our caller know he should post the request to the async
    //  queue.
    //
 
    if (CdAcquireVcbShared( IrpContext, Vcb, FromFsd )) {
 
        if (!CdAcquireFcbExclusive( IrpContext, Fcb, FromFsd )) {
 
            //
            //  We couldn't get the Fcb.  Release the Vcb and let our caller
            //  know to post this request.
            //
 
            CdReleaseVcb( IrpContext, Vcb );
            return FALSE;
        }
 
    //
    //  We didn't get the Vcb.  Let our caller know to post this request.
    //
 
    } else {
 
        return FALSE;
    }
 
    //
    //  Lock the Vcb and decrement the reference counts.
    //
 
    CdLockVcb( IrpContext, Vcb );
    CdDecrementReferenceCounts( IrpContext, Fcb, 1, UserReference );
    CdUnlockVcb( IrpContext, Vcb );
 
    //
    //  Call our teardown routine to see if this object can go away.
    //  If we don't remove the Fcb then release it.
    //
 
    CdTeardownStructures( IrpContext, Fcb, &RemovedFcb );
 
    if (!RemovedFcb) {
 
        CdReleaseFcb( IrpContext, Fcb );
    }
    else {
        _Analysis_assume_lock_not_held_(Fcb->FcbNonpaged->FcbResource);
    }
 
    //
    //  Release the Vcb and return to our caller.  Let him know we completed
    //  this request.
    //
 
    CdReleaseVcb( IrpContext, Vcb );
 
    return TRUE;
}
 
VOID
CdCloseWorker (
    _In_ PDEVICE_OBJECT DeviceObject,
    _In_opt_ PVOID Context
    )
/*++
 
Routine Description:
 
    Worker routine to call CsFspClose.
 
Arguments:
 
    DeviceObject - Filesystem registration device object
 
    Context - Callers context
 
Return Value:
 
    None
 
--*/
 
{
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER( DeviceObject );
    UNREFERENCED_PARAMETER( Context );
 
    CdFspClose (NULL);
}
 
VOID
CdQueueClose (
    _In_ PIRP_CONTEXT IrpContext,
    _In_ PFCB Fcb,
    _In_ ULONG UserReference,
    _In_ BOOLEAN DelayedClose
    )
 
/*++
 
Routine Description:
 
    This routine is called to queue a request to either the async or delayed
    close queue.  For the delayed queue we need to allocate a smaller
    structure to contain the information about the file object.  We do
    that so we don't put the larger IrpContext structures into this long
    lived queue.  If we can allocate this structure then we put this
    on the async queue instead.
 
Arguments:
 
    Fcb - Fcb for this file object.
 
    UserReference - Number of user references for this file object.  This is
        zero for an internal stream.
 
    DelayedClose - Indicates whether this should go on the async or delayed
        close queue.
 
Return Value:
 
    None
 
--*/
 
{
    PIRP_CONTEXT_LITE IrpContextLite = NULL;
    BOOLEAN StartWorker = FALSE;
 
    PAGED_CODE();
 
    ASSERT_IRP_CONTEXT( IrpContext );
    ASSERT_FCB( Fcb );
 
    //
    //  Start with the delayed queue request.  We can move this to the async
    //  queue if there is an allocation failure.
    //
 
    if (DelayedClose) {
 
        //
        //  Try to allocate non-paged pool for the IRP_CONTEXT_LITE.
        //
 
        IrpContextLite = CdCreateIrpContextLite( IrpContext );
    }
 
    //
    //  We want to clear the top level context in this thread if
    //  necessary.  Call our cleanup routine to do the work.
    //
 
    SetFlag( IrpContext->Flags, IRP_CONTEXT_FLAG_MORE_PROCESSING );
    CdCleanupIrpContext( IrpContext, TRUE );
 
    //
    //  Synchronize with the CdData lock.
    //
 
    CdLockCdData();
 
    //
    //  If we have an IrpContext then put the request on the delayed close queue.
    //
 
    if (IrpContextLite != NULL) {
 
        //
        //  Initialize the IrpContextLite.
        //
 
        IrpContextLite->NodeTypeCode = CDFS_NTC_IRP_CONTEXT_LITE;
        IrpContextLite->NodeByteSize = sizeof( IRP_CONTEXT_LITE );
        IrpContextLite->Fcb = Fcb;
        IrpContextLite->UserReference = UserReference;
        IrpContextLite->RealDevice = IrpContext->RealDevice;
 
        //
        //  Add this to the delayed close list and increment
        //  the count.
        //
 
        InsertTailList( &CdData.DelayedCloseQueue,
                        &IrpContextLite->DelayedCloseLinks );
 
        CdData.DelayedCloseCount += 1;
 
        //
        //  If we are above our threshold then start the delayed
        //  close operation.
        //
 
        if (CdData.DelayedCloseCount > CdData.MaxDelayedCloseCount) {
 
            CdData.ReduceDelayedClose = TRUE;
 
            if (!CdData.FspCloseActive) {
 
                CdData.FspCloseActive = TRUE;
                StartWorker = TRUE;
            }
        }
 
        //
        //  Unlock the CdData.
        //
 
        CdUnlockCdData();
 
        //
        //  Cleanup the IrpContext.
        //
 
        CdCompleteRequest( IrpContext, NULL, STATUS_SUCCESS );
 
    //
    //  Otherwise drop into the async case below.
    //
 
    } else {
 
        //
        //  Store the information about the file object into the IrpContext.
        //
 
        IrpContext->Irp = (PIRP) Fcb;
        IrpContext->ExceptionStatus = (NTSTATUS) UserReference;
 
        //
        //  Add this to the async close list and increment the count.
        //
 
        InsertTailList( &CdData.AsyncCloseQueue,
                        &IrpContext->WorkQueueItem.List );
 
        CdData.AsyncCloseCount += 1;
 
        //
        //  Remember to start the Fsp close thread if not currently started.
        //
 
        if (!CdData.FspCloseActive) {
 
            CdData.FspCloseActive = TRUE;
 
            StartWorker = TRUE;
        }
 
        //
        //  Unlock the CdData.
        //
 
        CdUnlockCdData();
    }
 
    //
    //  Start the FspClose thread if we need to.
    //
 
    if (StartWorker) {
 
        IoQueueWorkItem( CdData.CloseItem, CdCloseWorker, CriticalWorkQueue, NULL );
    }
 
    //
    //  Return to our caller.
    //
 
    return;
}
 
//
//  Local support routine
//
 
PIRP_CONTEXT
CdRemoveClose (
    _In_opt_ PVCB Vcb
    )
 
/*++
 
Routine Description:
 
Arguments:
 
    This routine is called to scan the async and delayed close queues looking
    for a suitable entry.  If the Vcb is specified then we scan both queues
    looking for an entry with the same Vcb.  Otherwise we will look in the
    async queue first for any close item.  If none found there then we look
    in the delayed close queue provided that we have triggered the delayed
    close operation.
 
Return Value:
 
    PIRP_CONTEXT - NULL if no work item found.  Otherwise it is the pointer to
        either the IrpContext or IrpContextLite for this request.
 
--*/
 
{
    PIRP_CONTEXT IrpContext = NULL;
    PIRP_CONTEXT NextIrpContext;
    PIRP_CONTEXT_LITE NextIrpContextLite;
 
    PLIST_ENTRY Entry;
 
    PAGED_CODE();
 
    ASSERT_OPTIONAL_VCB( Vcb );
 
    //
    //  Lock the CdData to perform the scan.
    //
 
    CdLockCdData();
 
    //
    //  First check the list of async closes.
    //
 
    Entry = CdData.AsyncCloseQueue.Flink;
 
    while (Entry != &CdData.AsyncCloseQueue) {
 
        //
        //  Extract the IrpContext.
        //
 
        NextIrpContext = CONTAINING_RECORD( Entry,
                                            IRP_CONTEXT,
                                            WorkQueueItem.List );
 
        //
        //  If no Vcb was specified or this Vcb is for our volume
        //  then perform the close.
        //
 
        if (!ARGUMENT_PRESENT( Vcb ) || (NextIrpContext->Vcb == Vcb)) {
 
            RemoveEntryList( Entry );
            CdData.AsyncCloseCount -= 1;
 
            IrpContext = NextIrpContext;
            break;
        }
 
        //
        //  Move to the next entry.
        //
 
        Entry = Entry->Flink;
    }
 
    //
    //  If we didn't find anything look through the delayed close
    //  queue.
    //
    //  We will only check the delayed close queue if we were given
    //  a Vcb or the delayed close operation is active.
    //
 
    if ((IrpContext == NULL) &&
        (ARGUMENT_PRESENT( Vcb ) ||
         (CdData.ReduceDelayedClose &&
          (CdData.DelayedCloseCount > CdData.MinDelayedCloseCount)))) {
 
        Entry = CdData.DelayedCloseQueue.Flink;
 
        while (Entry != &CdData.DelayedCloseQueue) {
 
            //
            //  Extract the IrpContext.
            //
 
            NextIrpContextLite = CONTAINING_RECORD( Entry,
                                                    IRP_CONTEXT_LITE,
                                                    DelayedCloseLinks );
 
            //
            //  If no Vcb was specified or this Vcb is for our volume
            //  then perform the close.
            //
 
            if (!ARGUMENT_PRESENT( Vcb ) || (NextIrpContextLite->Fcb->Vcb == Vcb)) {
 
                RemoveEntryList( Entry );
                CdData.DelayedCloseCount -= 1;
 
                IrpContext = (PIRP_CONTEXT) NextIrpContextLite;
                break;
            }
 
            //
            //  Move to the next entry.
            //
 
            Entry = Entry->Flink;
        }
    }
 
    //
    //  If the Vcb wasn't specified and we couldn't find an entry
    //  then turn off the Fsp thread.
    //
 
    if (!ARGUMENT_PRESENT( Vcb ) && (IrpContext == NULL)) {
 
        CdData.FspCloseActive = FALSE;
        CdData.ReduceDelayedClose = FALSE;
    }
 
    //
    //  Unlock the CdData.
    //
 
    CdUnlockCdData();
 
    return IrpContext;
}

Our Services

  • What our customers say about us?

© 2011-2025 All Rights Reserved. Joya Systems. 4425 South Mopac Building II Suite 101 Austin, TX 78735 Tel: 800-DEV-KERNEL

Privacy Policy. Terms of use. Valid XHTML & CSS