summaryrefslogtreecommitdiffstats
path: root/private/utils/untfs/inc/mft.hxx
blob: 4e9b67a1c6ca2dfe90ade85609830358e4fdf08e (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
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
/*++

Copyright (c) 1991	Microsoft Corporation

Module Name:

	mft.hxx

Abstract:

	This module contains the declarations for the NTFS_MASTER_FILE_TABLE
	class.	The MFT is the root of the file system

Author:

	Bill McJohn (billmc) 13-June-91

Environment:

    ULIB, User Mode

--*/

#if !defined( _NTFS_MASTER_FILE_TABLE_DEFN_ )

#define _NTFS_MASTER_FILE_TABLE_DEFN_

#include "ntfsbit.hxx"

DECLARE_CLASS( NTFS_ATTRIBUTE );
DECLARE_CLASS( NTFS_UPCASE_TABLE );

class NTFS_MASTER_FILE_TABLE : public OBJECT {

	public:

		DECLARE_CONSTRUCTOR( NTFS_MASTER_FILE_TABLE );

		VIRTUAL
		~NTFS_MASTER_FILE_TABLE(
			);

		NONVIRTUAL
		BOOLEAN
        Initialize(
            IN OUT  PNTFS_ATTRIBUTE     DataAttribute,
            IN OUT  PNTFS_BITMAP        MftBitmap,
            IN OUT  PNTFS_BITMAP        VolumeBitmap    OPTIONAL,
            IN      PNTFS_UPCASE_TABLE  UpcaseTable     OPTIONAL,
            IN      ULONG               ClusterFactor,
            IN      ULONG               FrsSize,
            IN      ULONG               SectorSize,
            IN      BIG_INT             VolumeSectors,
            IN      BOOLEAN             ReadOnly        DEFAULT FALSE
			);

		NONVIRTUAL
        UNTFS_EXPORT
        BOOLEAN
		AllocateFileRecordSegment(
            OUT PVCN    FileNumber,
            IN  BOOLEAN IsMft
			);

		NONVIRTUAL
        BOOLEAN
		FreeFileRecordSegment(
            IN  VCN SegmentToFree
            );

        NONVIRTUAL
        UNTFS_EXPORT
        BOOLEAN
        Extend(
            IN  ULONG   NumberOfSegmentsToAdd
            );

        NONVIRTUAL
        PNTFS_ATTRIBUTE
        GetDataAttribute(
            );

        NONVIRTUAL
        PNTFS_BITMAP
        GetMftBitmap(
            );

        NONVIRTUAL
        PNTFS_BITMAP
        GetVolumeBitmap(
            );

        NONVIRTUAL
        VOID
        EnableMethods(
            );

        NONVIRTUAL
        VOID
        DisableMethods(
            );

        NONVIRTUAL
        BOOLEAN
        AreMethodsEnabled(
            ) CONST;

        NONVIRTUAL
        ULONG
        QueryClusterFactor(
            ) CONST;

        NONVIRTUAL
        ULONG
        QueryFrsSize(
            ) CONST;

        NONVIRTUAL
        BIG_INT
        QueryVolumeSectors(
            ) CONST;

        NONVIRTUAL
        ULONG
        QuerySectorSize(
            ) CONST;

        NONVIRTUAL
        PNTFS_UPCASE_TABLE
        GetUpcaseTable(
            );

        NONVIRTUAL
        VOID
        SetUpcaseTable(
            IN PNTFS_UPCASE_TABLE UpcaseTable
            );

        NONVIRTUAL
        BIG_INT
        QueryFrsCount(
            );

	private:

		NONVIRTUAL
		VOID
		Construct(
			);

		NONVIRTUAL
		VOID
		Destroy(
			);

        PNTFS_ATTRIBUTE     _DataAttribute;
        PNTFS_BITMAP        _MftBitmap;
        PNTFS_BITMAP        _VolumeBitmap;
        PNTFS_UPCASE_TABLE  _UpcaseTable;
        ULONG               _ClusterFactor;
        ULONG               _BytesPerFrs;
        BOOLEAN             _MethodsEnabled;
        BOOLEAN             _ReadOnly;
        BIG_INT             _VolumeSectors;
        ULONG               _SectorSize;

};


INLINE
BOOLEAN
NTFS_MASTER_FILE_TABLE::FreeFileRecordSegment(
    IN  VCN SegmentToFree
	)
/*++

Routine Description:

	Free a File Record Segment in the Master File Table.

Arguments:

	SegmentToFree	-- supplies the virtual cluster number withing
						the Master File Table of the segment to be
						freed.

Return Value:

	TRUE upon successful completion.

--*/
{
    DebugAssert(_MftBitmap);

    return _MethodsEnabled ?
           (_MftBitmap->SetFree(SegmentToFree, 1), TRUE) : FALSE;
}


INLINE
PNTFS_ATTRIBUTE
NTFS_MASTER_FILE_TABLE::GetDataAttribute(
    )
/*++

Routine Description:

    This routine computes the MFT's $DATA attribute.

Arguments:

    None.

Return Value:

    The data attribute for this class.

--*/
{
    return _MethodsEnabled ? _DataAttribute : NULL;
}


INLINE
PNTFS_BITMAP
NTFS_MASTER_FILE_TABLE::GetMftBitmap(
    )
/*++

Routine Description:

    This routine computes the MFT's $BITMAP attribute.

Arguments:

    None.

Return Value:

    The mft bitmap.

--*/
{
    return _MethodsEnabled ? _MftBitmap : NULL;
}


INLINE
PNTFS_BITMAP
NTFS_MASTER_FILE_TABLE::GetVolumeBitmap(
    )
/*++

Routine Description:

    This routine return the volume bitmap

Arguments:

    None.

Return Value:

    The volume bitmap.

--*/
{
    return _MethodsEnabled ? _VolumeBitmap : NULL;
}


INLINE
VOID
NTFS_MASTER_FILE_TABLE::EnableMethods(
    )
/*++

Routine Description:

    This method enables the methods provided by this class.

    This method and its complement allow the user of this class to declare
    when the passed in data attribute and mft bitmap are good enough to
    use.

    After the class is initialized, all of the methods are enabled.

Arguments:

    None.

Return Value:

    None.

--*/
{
    _MethodsEnabled = TRUE;
}


INLINE
VOID
NTFS_MASTER_FILE_TABLE::DisableMethods(
    )
/*++

Routine Description:

    This method disables the methods provided by this class.

    This method and its complement allow the user of this class to declare
    when the passed in data attribute and mft bitmap are good enough to
    use.

    After the class is initialized, all of the methods are enabled.

Arguments:

    None.

Return Value:

    None.

--*/
{
    _MethodsEnabled = FALSE;
}


INLINE
BOOLEAN
NTFS_MASTER_FILE_TABLE::AreMethodsEnabled(
    ) CONST
/*++

Routine Description:

    This method computes whether or not the methods are enabled.

Arguments:

    None.

Return Value:

    FALSE   - The methods are not enabled.
    TRUE    - The methods are enabled.

--*/
{
    return _MethodsEnabled;
}


INLINE
ULONG
NTFS_MASTER_FILE_TABLE::QueryClusterFactor(
    ) CONST
/*++

Routine Description:

    This routine computes the number of sectors per cluster.

Arguments:

    None.

Return Value:

    The number of sectors per cluster.

--*/
{
    return _ClusterFactor;
}


INLINE
BIG_INT
NTFS_MASTER_FILE_TABLE::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 _VolumeSectors;
}


INLINE
ULONG
NTFS_MASTER_FILE_TABLE::QueryFrsSize(
    ) CONST
/*++

Routine Description:

    This routine computes the number of clusters per FRS.

Arguments:

    None.

Return Value:

    The number of clusters per FRS.

--*/
{
    return _BytesPerFrs;
}


INLINE
PNTFS_UPCASE_TABLE
NTFS_MASTER_FILE_TABLE::GetUpcaseTable(
    )
/*++

Routine Description:

    This method fetches the upcase table for the volume.

Arguments:

    None.

Return Value:

    The volume upcase table.

--*/
{
    return _UpcaseTable;
}


INLINE
VOID
NTFS_MASTER_FILE_TABLE::SetUpcaseTable(
    IN PNTFS_UPCASE_TABLE UpcaseTable
    )
/*++

Routine Description:

    This method sets the upcase table for the volume.

Arguments:

    UpcaseTable --  Supplies the volume upcase table.

Return Value:

    None.

--*/
{
    _UpcaseTable = UpcaseTable;
}

INLINE
ULONG
NTFS_MASTER_FILE_TABLE::QuerySectorSize(
    ) CONST
{
    return _SectorSize;
}


#endif