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
|
/*++
Copyright (c) 1991 Microsoft Corporation
Module Name:
frsstruc.hxx
Abstract:
This class models a file record segment structure.
Author:
Norbert P. Kusters (norbertk) 17-Sep-91
Environment:
ULIB, User Mode
--*/
#if !defined( _NTFS_FRS_STRUCTURE_DEFN_ )
#define _NTFS_FRS_STRUCTURE_DEFN_
#include "volume.hxx"
#include "ntfssa.hxx"
DECLARE_CLASS( NTFS_FRS_STRUCTURE );
DECLARE_CLASS( MEM );
DECLARE_CLASS( NTFS_ATTRIBUTE );
DECLARE_CLASS( LOG_IO_DP_DRIVE );
DECLARE_CLASS( NTFS_CLUSTER_RUN );
DECLARE_CLASS( WSTRING );
DECLARE_CLASS( MESSAGE );
DECLARE_CLASS( NTFS_ATTRIBUTE_COLUMNS );
DECLARE_CLASS( NTFS_ATTRIBUTE_LIST );
DECLARE_CLASS( NTFS_BITMAP );
DECLARE_CLASS( NTFS_UPCASE_TABLE );
class NTFS_FRS_STRUCTURE : public OBJECT {
public:
UNTFS_EXPORT
DECLARE_CONSTRUCTOR( NTFS_FRS_STRUCTURE );
VIRTUAL
UNTFS_EXPORT
~NTFS_FRS_STRUCTURE(
);
NONVIRTUAL
UNTFS_EXPORT
BOOLEAN
Initialize(
IN OUT PMEM Mem,
IN OUT PNTFS_ATTRIBUTE MftData,
IN VCN FileNumber,
IN ULONG ClusterFactor,
IN BIG_INT VolumeSectors,
IN ULONG FrsSize,
IN PNTFS_UPCASE_TABLE UpcaseTable OPTIONAL
);
NONVIRTUAL
UNTFS_EXPORT
BOOLEAN
Initialize(
IN OUT PMEM Mem,
IN OUT PLOG_IO_DP_DRIVE Drive,
IN LCN StartOfMft,
IN ULONG ClusterFactor,
IN BIG_INT VolumeSectors,
IN ULONG FrsSize,
IN PNTFS_UPCASE_TABLE UpcaseTable DEFAULT NULL,
IN ULONG Offset DEFAULT 0
);
NONVIRTUAL
BOOLEAN
VerifyAndFix(
IN FIX_LEVEL FixLevel,
IN OUT PMESSAGE Message,
IN PCNTFS_ATTRIBUTE_COLUMNS AttributeDefTable OPTIONAL,
IN OUT PBOOLEAN DiskErrorsFound DEFAULT NULL
);
NONVIRTUAL
BOOLEAN
LoneFrsAllocationCheck(
IN OUT PNTFS_BITMAP VolumeBitmap,
IN OUT PNTFS_CHKDSK_REPORT ChkdskReport,
IN OUT PNTFS_CHKDSK_INFO ChkdskInfo,
IN FIX_LEVEL FixLevel,
IN OUT PMESSAGE Message,
IN OUT PBOOLEAN DiskErrorsFound DEFAULT NULL
);
NONVIRTUAL
BOOLEAN
CheckInstanceTags(
IN FIX_LEVEL FixLevel,
IN OUT PMESSAGE Message,
OUT PBOOLEAN Changes,
IN OUT PNTFS_ATTRIBUTE_LIST AttributeList DEFAULT NULL
);
VIRTUAL
UNTFS_EXPORT
BOOLEAN
Read(
);
NONVIRTUAL
UNTFS_EXPORT
BOOLEAN
Write(
);
NONVIRTUAL
UNTFS_EXPORT
PVOID
GetNextAttributeRecord(
IN PCVOID AttributeRecord,
IN OUT PMESSAGE Message DEFAULT NULL,
OUT PBOOLEAN ErrorsFound DEFAULT NULL
);
NONVIRTUAL
VOID
DeleteAttributeRecord(
IN OUT PVOID AttributeRecord
);
NONVIRTUAL
BOOLEAN
InsertAttributeRecord(
IN OUT PVOID Position,
IN PCVOID AttributeRecord
);
NONVIRTUAL
UNTFS_EXPORT
BOOLEAN
QueryAttributeList(
OUT PNTFS_ATTRIBUTE_LIST AttributeList
);
NONVIRTUAL
PVOID
GetAttribute(
IN ULONG TypeCode
);
NONVIRTUAL
PVOID
GetAttributeList(
);
NONVIRTUAL
BOOLEAN
UpdateAttributeList(
IN PCNTFS_ATTRIBUTE_LIST AttributeList,
IN BOOLEAN WriteList
);
NONVIRTUAL
UNTFS_EXPORT
BOOLEAN
SafeQueryAttribute(
IN ATTRIBUTE_TYPE_CODE TypeCode,
IN OUT PNTFS_ATTRIBUTE MftData,
OUT PNTFS_ATTRIBUTE Attribute
);
NONVIRTUAL
MFT_SEGMENT_REFERENCE
QuerySegmentReference(
) CONST;
NONVIRTUAL
FILE_REFERENCE
QueryBaseFileRecordSegment(
) CONST;
NONVIRTUAL
BOOLEAN
IsBase(
) CONST;
NONVIRTUAL
BOOLEAN
IsInUse(
) CONST;
NONVIRTUAL
VOID
ClearInUse(
);
NONVIRTUAL
BOOLEAN
IsSystemFile(
) CONST;
NONVIRTUAL
VOID
SetSystemFile(
);
NONVIRTUAL
BOOLEAN
IsViewIndexPresent(
) CONST;
NONVIRTUAL
VOID
SetViewIndexPresent(
);
NONVIRTUAL
BOOLEAN
IsIndexPresent(
) CONST;
NONVIRTUAL
VOID
SetIndexPresent(
);
NONVIRTUAL
VOID
ClearIndexPresent(
);
NONVIRTUAL
VCN
QueryFileNumber(
) CONST;
NONVIRTUAL
ULONG
QueryClusterFactor(
) CONST;
NONVIRTUAL
ULONG
QuerySize(
) CONST;
NONVIRTUAL
PLOG_IO_DP_DRIVE
GetDrive(
);
NONVIRTUAL
USHORT
QueryReferenceCount(
) CONST;
NONVIRTUAL
VOID
SetReferenceCount(
IN USHORT ReferenceCount
);
NONVIRTUAL
BIG_INT
QueryVolumeSectors(
) CONST;
NONVIRTUAL
PNTFS_UPCASE_TABLE
GetUpcaseTable(
);
NONVIRTUAL
VOID
SetUpcaseTable(
IN PNTFS_UPCASE_TABLE UpcaseTable
);
NONVIRTUAL
LSN
QueryLsn(
) CONST;
protected:
NONVIRTUAL
ULONG
QueryAvailableSpace(
);
PFILE_RECORD_SEGMENT_HEADER _FrsData;
private:
NONVIRTUAL
BOOLEAN
Sort(
OUT PBOOLEAN Changes,
OUT PBOOLEAN Duplicates
);
NONVIRTUAL
VOID
Construct(
);
NONVIRTUAL
VOID
Destroy(
);
PSECRUN _secrun;
PNTFS_ATTRIBUTE _mftdata;
PNTFS_UPCASE_TABLE _upcase_table;
VCN _file_number;
ULONG _cluster_factor;
ULONG _size;
PLOG_IO_DP_DRIVE _drive;
BIG_INT _volume_sectors;
};
INLINE
MFT_SEGMENT_REFERENCE
NTFS_FRS_STRUCTURE::QuerySegmentReference(
) CONST
/*++
Routine Description:
This routine computes the segment reference value for this FRS.
Arguments:
None.
Return Value:
The segment reference value for this FRS.
--*/
{
MFT_SEGMENT_REFERENCE SegmentReference;
DebugAssert( _FrsData );
SegmentReference.LowPart = _file_number.GetLowPart();
SegmentReference.HighPart = (USHORT) _file_number.GetHighPart();
SegmentReference.SequenceNumber = _FrsData->SequenceNumber;
return SegmentReference;
}
INLINE
FILE_REFERENCE
NTFS_FRS_STRUCTURE::QueryBaseFileRecordSegment(
) CONST
/*++
Routine Description:
This field contains a pointer to the base file record segment for
this file record segment.
Arguments:
None.
Return Value:
A FILE_REFERENCE to the base file record segment for this file
record segment.
--*/
{
DebugAssert( _FrsData );
return _FrsData->BaseFileRecordSegment;
}
INLINE
BOOLEAN
NTFS_FRS_STRUCTURE::IsBase(
) CONST
/*++
Routine Description:
This method determines whether this File Record Segment is the
Base File Record Segment for its file.
Arguments:
None.
Return Value:
TRUE if this is a Base File Record Segment; FALSE otherwise.
--*/
{
return( _FrsData->BaseFileRecordSegment.LowPart == 0 &&
_FrsData->BaseFileRecordSegment.HighPart == 0 &&
_FrsData->BaseFileRecordSegment.SequenceNumber == 0 );
}
INLINE
BOOLEAN
NTFS_FRS_STRUCTURE::IsInUse(
) CONST
/*++
Routine Description:
This routine computes whether or not this file record segment is in
use.
Arguments:
None.
Return Value:
FALSE - This file record segment is not in use.
TRUE - This file record segment is in use.
--*/
{
DebugAssert( _FrsData );
return (_FrsData->Flags & FILE_RECORD_SEGMENT_IN_USE) ? TRUE : FALSE;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::ClearInUse(
)
/*++
Routine Description:
This routine clears the in use bit on this file record segment.
Arguments:
None.
Return Value:
None.
--*/
{
DebugAssert( _FrsData );
_FrsData->Flags &= ~FILE_RECORD_SEGMENT_IN_USE;
}
INLINE
BOOLEAN
NTFS_FRS_STRUCTURE::IsSystemFile(
) CONST
/*++
Routine Description:
This routine computes whether or not this file record segment is a
system file.
Arguments:
None.
Return Value:
FALSE - This file record segment is not a system file.
TRUE - This file record segment is a system file.
--*/
{
DebugAssert( _FrsData );
return (_FrsData->Flags & FILE_SYSTEM_FILE) ? TRUE : FALSE;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::SetSystemFile(
)
/*++
Routine Description:
This routine sets the system file bit on this file record segment.
Arguments:
None.
Return Value:
None.
--*/
{
DebugAssert( _FrsData );
_FrsData->Flags |= FILE_SYSTEM_FILE;
}
INLINE
BOOLEAN
NTFS_FRS_STRUCTURE::IsViewIndexPresent(
) CONST
/*++
Routine Description:
This routine computes whether or not the indices of file record segment
can be viewed.
Arguments:
None.
Return Value:
FALSE - The indices of this file record segment cannot be viewed.
TRUE - The indices of this file record segment can be viewed.
--*/
{
DebugAssert( _FrsData );
return (_FrsData->Flags & FILE_VIEW_INDEX_PRESENT) ? TRUE : FALSE;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::SetViewIndexPresent(
)
/*++
Routine Description:
This routine sets the view index present bit on this file record segment.
Arguments:
None.
Return Value:
None.
--*/
{
DebugAssert( _FrsData );
_FrsData->Flags |= FILE_VIEW_INDEX_PRESENT;
}
INLINE
BOOLEAN
NTFS_FRS_STRUCTURE::IsIndexPresent(
) CONST
/*++
Routine Description:
This routine computes whether or not this file record segment's
FILE_NAME_INDEX_PRESENT flag is set.
Arguments:
None.
Return Value:
FALSE - This file record segment's FILE_NAME_INDEX_PRESENT is NOT set.
TRUE - This file record segment's FILE_NAME_INDEX_PRESENT is set.
--*/
{
DebugAssert( _FrsData );
return (_FrsData->Flags & FILE_FILE_NAME_INDEX_PRESENT) ? TRUE : FALSE;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::ClearIndexPresent(
)
/*++
Routine Description:
This routine clears the index present bit on this file record segment.
Arguments:
None.
Return Value:
None.
--*/
{
DebugAssert( _FrsData );
_FrsData->Flags &= ~FILE_FILE_NAME_INDEX_PRESENT;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::SetIndexPresent(
)
/*++
Routine Description:
This routine sets the index present bit on this file record segment.
Arguments:
None.
Return Value:
None.
--*/
{
DebugAssert( _FrsData );
_FrsData->Flags |= FILE_FILE_NAME_INDEX_PRESENT;
}
INLINE
ULONG
NTFS_FRS_STRUCTURE::QuerySize(
) CONST
/*++
Routine Description:
This routine computes the number of bytes in this file
record segment.
Arguments:
None.
Return Value:
The number of bytes in this file record segment.
--*/
{
return _size;
}
INLINE
VCN
NTFS_FRS_STRUCTURE::QueryFileNumber(
) CONST
/*++
Routine Description:
This method returns the File Number of the File Record Segment.
Arguments:
None.
Return Value:
the File Number (i.e. ordinal number within the MFT) of this
File Record Segment.
--*/
{
return _file_number;
}
INLINE
ULONG
NTFS_FRS_STRUCTURE::QueryClusterFactor(
) CONST
/*++
Routine Description:
This method returns the cluster factor.
Arguments:
None.
Return Value:
The cluster factor with which this File Record Segment was initialized.
--*/
{
return _cluster_factor;
}
INLINE
PLOG_IO_DP_DRIVE
NTFS_FRS_STRUCTURE::GetDrive(
)
/*++
Routine Description:
This method returns the drive on which the File Record Segment
resides. This functionality enables clients to initialize
other File Record Segments on the same drive.
Arguments:
None.
Return Value:
The drive on which the File Record Segment resides.
--*/
{
return _drive;
}
INLINE
USHORT
NTFS_FRS_STRUCTURE::QueryReferenceCount(
) CONST
/*++
Routine Description:
This routine returns the value of the reference count field
in this frs.
Arguments:
None.
Return Value:
The value of the reference count field in this frs.
--*/
{
return _FrsData->ReferenceCount;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::SetReferenceCount(
IN USHORT ReferenceCount
)
/*++
Routine Description:
This routine sets the value of the reference count field
in this frs.
Arguments:
ReferenceCount - Supplies the new reference count.
Return Value:
None.
--*/
{
_FrsData->ReferenceCount = ReferenceCount;
}
INLINE
BIG_INT
NTFS_FRS_STRUCTURE::QueryVolumeSectors(
) CONST
/*++
Routine Description:
This routine returns the number of sectors on the volume as recorded in
the boot sector.
Arguments:
None.
Return Value:
The number of volume sectors.
--*/
{
return _volume_sectors;
}
INLINE
PNTFS_UPCASE_TABLE
NTFS_FRS_STRUCTURE::GetUpcaseTable(
)
/*++
Routine Description:
This method fetches the upcase table for the volume on which
this FRS resides.
Arguments:
None.
Return Value:
The volume upcase table.
--*/
{
return _upcase_table;
}
INLINE
VOID
NTFS_FRS_STRUCTURE::SetUpcaseTable(
IN PNTFS_UPCASE_TABLE UpcaseTable
)
/*++
Routine Description:
This method sets the upcase table for the volume on which
this FRS resides.
Arguments:
UpcaseTable -- Supplies the volume upcase table.
Return Value:
None.
--*/
{
_upcase_table = UpcaseTable;
}
INLINE
LSN
NTFS_FRS_STRUCTURE::QueryLsn(
) CONST
/*++
Routine Description:
This routine returns the logical sequence number for this file
record segment.
Arguments:
None.
Return Value:
The logical sequence number for this file record segment.
--*/
{
DebugAssert( _FrsData );
return _FrsData->Lsn;
}
#endif // _NTFS_FRS_STRUCTURE_DEFN_
|