0b64b7247eddd138acfb47ff14a7159853dfa633
[reactos.git] / drivers / filesystems / ntfs / ntfs.h
1 #ifndef NTFS_H
2 #define NTFS_H
3
4 #include <ntifs.h>
5 #include <pseh/pseh2.h>
6
7 #ifdef __GNUC__
8 #define INIT_SECTION __attribute__((section ("INIT")))
9 #else
10 #define INIT_SECTION /* Done via alloc_text for MSC */
11 #endif
12
13 #define CACHEPAGESIZE(pDeviceExt) \
14 ((pDeviceExt)->NtfsInfo.UCHARsPerCluster > PAGE_SIZE ? \
15 (pDeviceExt)->NtfsInfo.UCHARsPerCluster : PAGE_SIZE)
16
17 #define TAG_NTFS 'SFTN'
18
19 #define ROUND_UP(N, S) ((((N) + (S) - 1) / (S)) * (S))
20 #define ROUND_DOWN(N, S) ((N) - ((N) % (S)))
21
22 #define DEVICE_NAME L"\\Ntfs"
23
24 #include <pshpack1.h>
25 typedef struct _BIOS_PARAMETERS_BLOCK
26 {
27 USHORT BytesPerSector; // 0x0B
28 UCHAR SectorsPerCluster; // 0x0D
29 UCHAR Unused0[7]; // 0x0E, checked when volume is mounted
30 UCHAR MediaId; // 0x15
31 UCHAR Unused1[2]; // 0x16
32 USHORT SectorsPerTrack; // 0x18
33 USHORT Heads; // 0x1A
34 UCHAR Unused2[4]; // 0x1C
35 UCHAR Unused3[4]; // 0x20, checked when volume is mounted
36 } BIOS_PARAMETERS_BLOCK, *PBIOS_PARAMETERS_BLOCK;
37
38 typedef struct _EXTENDED_BIOS_PARAMETERS_BLOCK
39 {
40 USHORT Unknown[2]; // 0x24, always 80 00 80 00
41 ULONGLONG SectorCount; // 0x28
42 ULONGLONG MftLocation; // 0x30
43 ULONGLONG MftMirrLocation; // 0x38
44 CHAR ClustersPerMftRecord; // 0x40
45 UCHAR Unused4[3]; // 0x41
46 CHAR ClustersPerIndexRecord; // 0x44
47 UCHAR Unused5[3]; // 0x45
48 ULONGLONG SerialNumber; // 0x48
49 UCHAR Checksum[4]; // 0x50
50 } EXTENDED_BIOS_PARAMETERS_BLOCK, *PEXTENDED_BIOS_PARAMETERS_BLOCK;
51
52 typedef struct _BOOT_SECTOR
53 {
54 UCHAR Jump[3]; // 0x00
55 UCHAR OEMID[8]; // 0x03
56 BIOS_PARAMETERS_BLOCK BPB;
57 EXTENDED_BIOS_PARAMETERS_BLOCK EBPB;
58 UCHAR BootStrap[426]; // 0x54
59 USHORT EndSector; // 0x1FE
60 } BOOT_SECTOR, *PBOOT_SECTOR;
61 #include <poppack.h>
62
63 //typedef struct _BootSector BootSector;
64
65 typedef struct _NTFS_INFO
66 {
67 ULONG BytesPerSector;
68 ULONG SectorsPerCluster;
69 ULONG BytesPerCluster;
70 ULONGLONG SectorCount;
71 ULONGLONG ClusterCount;
72 ULARGE_INTEGER MftStart;
73 ULARGE_INTEGER MftMirrStart;
74 ULONG BytesPerFileRecord;
75 ULONG BytesPerIndexRecord;
76
77 ULONGLONG SerialNumber;
78 USHORT VolumeLabelLength;
79 WCHAR VolumeLabel[MAXIMUM_VOLUME_LABEL_LENGTH];
80 UCHAR MajorVersion;
81 UCHAR MinorVersion;
82 USHORT Flags;
83
84 ULONG MftZoneReservation;
85 } NTFS_INFO, *PNTFS_INFO;
86
87 #define NTFS_TYPE_CCB '20SF'
88 #define NTFS_TYPE_FCB '30SF'
89 #define NTFS_TYPE_VCB '50SF'
90 #define NTFS_TYPE_IRP_CONTEXT '60SF'
91 #define NTFS_TYPE_GLOBAL_DATA '70SF'
92
93 typedef struct
94 {
95 ULONG Type;
96 ULONG Size;
97 } NTFSIDENTIFIER, *PNTFSIDENTIFIER;
98
99 typedef struct
100 {
101 NTFSIDENTIFIER Identifier;
102
103 ERESOURCE DirResource;
104 // ERESOURCE FatResource;
105
106 KSPIN_LOCK FcbListLock;
107 LIST_ENTRY FcbListHead;
108
109 PVPB Vpb;
110 PDEVICE_OBJECT StorageDevice;
111 PFILE_OBJECT StreamFileObject;
112
113 struct _NTFS_ATTR_CONTEXT* MFTContext;
114 struct _FILE_RECORD_HEADER* MasterFileTable;
115 struct _FCB *VolumeFcb;
116
117 NTFS_INFO NtfsInfo;
118
119 ULONG MftDataOffset;
120 ULONG Flags;
121 ULONG OpenHandleCount;
122
123 } DEVICE_EXTENSION, *PDEVICE_EXTENSION, NTFS_VCB, *PNTFS_VCB;
124
125 #define VCB_VOLUME_LOCKED 0x0001
126
127 typedef struct
128 {
129 NTFSIDENTIFIER Identifier;
130 LIST_ENTRY NextCCB;
131 PFILE_OBJECT PtrFileObject;
132 LARGE_INTEGER CurrentByteOffset;
133 /* for DirectoryControl */
134 ULONG Entry;
135 /* for DirectoryControl */
136 PWCHAR DirectorySearchPattern;
137 ULONG LastCluster;
138 ULONG LastOffset;
139 } NTFS_CCB, *PNTFS_CCB;
140
141 #define TAG_CCB 'BCCI'
142 #define TAG_FCB 'BCFI'
143
144 typedef struct
145 {
146 NTFSIDENTIFIER Identifier;
147 ERESOURCE Resource;
148 PDRIVER_OBJECT DriverObject;
149 PDEVICE_OBJECT DeviceObject;
150 CACHE_MANAGER_CALLBACKS CacheMgrCallbacks;
151 ULONG Flags;
152 FAST_IO_DISPATCH FastIoDispatch;
153 NPAGED_LOOKASIDE_LIST IrpContextLookasideList;
154 NPAGED_LOOKASIDE_LIST FcbLookasideList;
155 NPAGED_LOOKASIDE_LIST AttrCtxtLookasideList;
156 BOOLEAN EnableWriteSupport;
157 } NTFS_GLOBAL_DATA, *PNTFS_GLOBAL_DATA;
158
159
160 typedef enum
161 {
162 AttributeStandardInformation = 0x10,
163 AttributeAttributeList = 0x20,
164 AttributeFileName = 0x30,
165 AttributeObjectId = 0x40,
166 AttributeSecurityDescriptor = 0x50,
167 AttributeVolumeName = 0x60,
168 AttributeVolumeInformation = 0x70,
169 AttributeData = 0x80,
170 AttributeIndexRoot = 0x90,
171 AttributeIndexAllocation = 0xA0,
172 AttributeBitmap = 0xB0,
173 AttributeReparsePoint = 0xC0,
174 AttributeEAInformation = 0xD0,
175 AttributeEA = 0xE0,
176 AttributePropertySet = 0xF0,
177 AttributeLoggedUtilityStream = 0x100,
178 AttributeEnd = 0xFFFFFFFF
179 } ATTRIBUTE_TYPE, *PATTRIBUTE_TYPE;
180
181 // FILE_RECORD_END seems to follow AttributeEnd in every file record starting with $Quota.
182 // No clue what data is being represented here.
183 #define FILE_RECORD_END 0x11477982
184
185 #define NTFS_FILE_MFT 0
186 #define NTFS_FILE_MFTMIRR 1
187 #define NTFS_FILE_LOGFILE 2
188 #define NTFS_FILE_VOLUME 3
189 #define NTFS_FILE_ATTRDEF 4
190 #define NTFS_FILE_ROOT 5
191 #define NTFS_FILE_BITMAP 6
192 #define NTFS_FILE_BOOT 7
193 #define NTFS_FILE_BADCLUS 8
194 #define NTFS_FILE_QUOTA 9
195 #define NTFS_FILE_UPCASE 10
196 #define NTFS_FILE_EXTEND 11
197 #define NTFS_FILE_FIRST_USER_FILE 16
198
199 #define NTFS_MFT_MASK 0x0000FFFFFFFFFFFFULL
200
201 #define COLLATION_BINARY 0x00
202 #define COLLATION_FILE_NAME 0x01
203 #define COLLATION_UNICODE_STRING 0x02
204 #define COLLATION_NTOFS_ULONG 0x10
205 #define COLLATION_NTOFS_SID 0x11
206 #define COLLATION_NTOFS_SECURITY_HASH 0x12
207 #define COLLATION_NTOFS_ULONGS 0x13
208
209 #define INDEX_ROOT_SMALL 0x0
210 #define INDEX_ROOT_LARGE 0x1
211
212 #define INDEX_NODE_SMALL 0x0
213 #define INDEX_NODE_LARGE 0x1
214
215 #define NTFS_INDEX_ENTRY_NODE 1
216 #define NTFS_INDEX_ENTRY_END 2
217
218 #define NTFS_FILE_NAME_POSIX 0
219 #define NTFS_FILE_NAME_WIN32 1
220 #define NTFS_FILE_NAME_DOS 2
221 #define NTFS_FILE_NAME_WIN32_AND_DOS 3
222
223 #define NTFS_FILE_TYPE_READ_ONLY 0x1
224 #define NTFS_FILE_TYPE_HIDDEN 0x2
225 #define NTFS_FILE_TYPE_SYSTEM 0x4
226 #define NTFS_FILE_TYPE_ARCHIVE 0x20
227 #define NTFS_FILE_TYPE_REPARSE 0x400
228 #define NTFS_FILE_TYPE_COMPRESSED 0x800
229 #define NTFS_FILE_TYPE_DIRECTORY 0x10000000
230
231 /* Indexed Flag in Resident attributes - still somewhat speculative */
232 #define RA_INDEXED 0x01
233
234 typedef struct
235 {
236 ULONG Type; /* Magic number 'FILE' */
237 USHORT UsaOffset; /* Offset to the update sequence */
238 USHORT UsaCount; /* Size in words of Update Sequence Number & Array (S) */
239 ULONGLONG Lsn; /* $LogFile Sequence Number (LSN) */
240 } NTFS_RECORD_HEADER, *PNTFS_RECORD_HEADER;
241
242 /* NTFS_RECORD_HEADER.Type */
243 #define NRH_FILE_TYPE 0x454C4946 /* 'FILE' */
244 #define NRH_INDX_TYPE 0x58444E49 /* 'INDX' */
245
246
247 typedef struct _FILE_RECORD_HEADER
248 {
249 NTFS_RECORD_HEADER Ntfs;
250 USHORT SequenceNumber; /* Sequence number */
251 USHORT LinkCount; /* Hard link count */
252 USHORT AttributeOffset; /* Offset to the first Attribute */
253 USHORT Flags; /* Flags */
254 ULONG BytesInUse; /* Real size of the FILE record */
255 ULONG BytesAllocated; /* Allocated size of the FILE record */
256 ULONGLONG BaseFileRecord; /* File reference to the base FILE record */
257 USHORT NextAttributeNumber; /* Next Attribute Id */
258 USHORT Padding; /* Align to 4 UCHAR boundary (XP) */
259 ULONG MFTRecordNumber; /* Number of this MFT Record (XP) */
260 } FILE_RECORD_HEADER, *PFILE_RECORD_HEADER;
261
262 /* Flags in FILE_RECORD_HEADER */
263
264 #define FRH_IN_USE 0x0001 /* Record is in use */
265 #define FRH_DIRECTORY 0x0002 /* Record is a directory */
266 #define FRH_UNKNOWN1 0x0004 /* Don't know */
267 #define FRH_UNKNOWN2 0x0008 /* Don't know */
268
269 typedef struct
270 {
271 ULONG Type;
272 ULONG Length;
273 UCHAR IsNonResident;
274 UCHAR NameLength;
275 USHORT NameOffset;
276 USHORT Flags;
277 USHORT Instance;
278 union
279 {
280 // Resident attributes
281 struct
282 {
283 ULONG ValueLength;
284 USHORT ValueOffset;
285 UCHAR Flags;
286 UCHAR Reserved;
287 } Resident;
288 // Non-resident attributes
289 struct
290 {
291 ULONGLONG LowestVCN;
292 ULONGLONG HighestVCN;
293 USHORT MappingPairsOffset;
294 USHORT CompressionUnit;
295 UCHAR Reserved[4];
296 LONGLONG AllocatedSize;
297 LONGLONG DataSize;
298 LONGLONG InitializedSize;
299 LONGLONG CompressedSize;
300 } NonResident;
301 };
302 } NTFS_ATTR_RECORD, *PNTFS_ATTR_RECORD;
303
304 // The beginning and length of an attribute record are always aligned to an 8-byte boundary,
305 // relative to the beginning of the file record.
306 #define ATTR_RECORD_ALIGNMENT 8
307
308 // Data runs are aligned to a 4-byte boundary, relative to the start of the attribute record
309 #define DATA_RUN_ALIGNMENT 4
310
311 // Value offset is aligned to a 4-byte boundary, relative to the start of the attribute record
312 #define VALUE_OFFSET_ALIGNMENT 4
313
314 typedef struct
315 {
316 ULONGLONG CreationTime;
317 ULONGLONG ChangeTime;
318 ULONGLONG LastWriteTime;
319 ULONGLONG LastAccessTime;
320 ULONG FileAttribute;
321 ULONG AlignmentOrReserved[3];
322 #if 0
323 ULONG QuotaId;
324 ULONG SecurityId;
325 ULONGLONG QuotaCharge;
326 USN Usn;
327 #endif
328 } STANDARD_INFORMATION, *PSTANDARD_INFORMATION;
329
330
331 typedef struct
332 {
333 ATTRIBUTE_TYPE AttributeType;
334 USHORT Length;
335 UCHAR NameLength;
336 UCHAR NameOffset;
337 ULONGLONG StartVcn; // LowVcn
338 ULONGLONG FileReferenceNumber;
339 USHORT AttributeNumber;
340 USHORT AlignmentOrReserved[3];
341 } ATTRIBUTE_LIST, *PATTRIBUTE_LIST;
342
343
344 typedef struct
345 {
346 ULONGLONG DirectoryFileReferenceNumber;
347 ULONGLONG CreationTime;
348 ULONGLONG ChangeTime;
349 ULONGLONG LastWriteTime;
350 ULONGLONG LastAccessTime;
351 ULONGLONG AllocatedSize;
352 ULONGLONG DataSize;
353 ULONG FileAttributes;
354 union
355 {
356 struct
357 {
358 USHORT PackedEaSize;
359 USHORT AlignmentOrReserved;
360 } EaInfo;
361 ULONG ReparseTag;
362 } Extended;
363 UCHAR NameLength;
364 UCHAR NameType;
365 WCHAR Name[1];
366 } FILENAME_ATTRIBUTE, *PFILENAME_ATTRIBUTE;
367
368 typedef struct
369 {
370 ULONG FirstEntryOffset;
371 ULONG TotalSizeOfEntries;
372 ULONG AllocatedSize;
373 UCHAR Flags;
374 UCHAR Padding[3];
375 } INDEX_HEADER_ATTRIBUTE, *PINDEX_HEADER_ATTRIBUTE;
376
377 typedef struct
378 {
379 ULONG AttributeType;
380 ULONG CollationRule;
381 ULONG SizeOfEntry;
382 UCHAR ClustersPerIndexRecord;
383 UCHAR Padding[3];
384 INDEX_HEADER_ATTRIBUTE Header;
385 } INDEX_ROOT_ATTRIBUTE, *PINDEX_ROOT_ATTRIBUTE;
386
387 typedef struct
388 {
389 NTFS_RECORD_HEADER Ntfs;
390 ULONGLONG VCN;
391 INDEX_HEADER_ATTRIBUTE Header;
392 } INDEX_BUFFER, *PINDEX_BUFFER;
393
394 typedef struct
395 {
396 union
397 {
398 struct
399 {
400 ULONGLONG IndexedFile;
401 } Directory;
402 struct
403 {
404 USHORT DataOffset;
405 USHORT DataLength;
406 ULONG Reserved;
407 } ViewIndex;
408 } Data;
409 USHORT Length;
410 USHORT KeyLength;
411 USHORT Flags;
412 USHORT Reserved;
413 FILENAME_ATTRIBUTE FileName;
414 } INDEX_ENTRY_ATTRIBUTE, *PINDEX_ENTRY_ATTRIBUTE;
415
416 struct _B_TREE_FILENAME_NODE;
417 typedef struct _B_TREE_FILENAME_NODE B_TREE_FILENAME_NODE;
418
419 // Keys are arranged in nodes as an ordered, linked list
420 typedef struct _B_TREE_KEY
421 {
422 struct _B_TREE_KEY *NextKey;
423 B_TREE_FILENAME_NODE *LesserChild; // Child-Node. All the keys in this node will be sorted before IndexEntry
424 PINDEX_ENTRY_ATTRIBUTE IndexEntry; // must be last member for FIELD_OFFSET
425 }B_TREE_KEY, *PB_TREE_KEY;
426
427 // Every Node is just an ordered list of keys.
428 // Sub-nodes can be found attached to a key (if they exist).
429 // A key's sub-node precedes that key in the ordered list.
430 typedef struct _B_TREE_FILENAME_NODE
431 {
432 ULONG KeyCount;
433 BOOLEAN HasValidVCN;
434 BOOLEAN DiskNeedsUpdating;
435 ULONGLONG VCN;
436 PB_TREE_KEY FirstKey;
437 } B_TREE_FILENAME_NODE, *PB_TREE_FILENAME_NODE;
438
439 typedef struct
440 {
441 PB_TREE_FILENAME_NODE RootNode;
442 } B_TREE, *PB_TREE;
443
444 typedef struct
445 {
446 ULONGLONG Unknown1;
447 UCHAR MajorVersion;
448 UCHAR MinorVersion;
449 USHORT Flags;
450 ULONG Unknown2;
451 } VOLINFO_ATTRIBUTE, *PVOLINFO_ATTRIBUTE;
452
453 typedef struct {
454 ULONG ReparseTag;
455 USHORT DataLength;
456 USHORT Reserved;
457 UCHAR Data[1];
458 } REPARSE_POINT_ATTRIBUTE, *PREPARSE_POINT_ATTRIBUTE;
459
460 #define IRPCONTEXT_CANWAIT 0x1
461 #define IRPCONTEXT_COMPLETE 0x2
462 #define IRPCONTEXT_QUEUE 0x4
463
464 typedef struct
465 {
466 NTFSIDENTIFIER Identifier;
467 ULONG Flags;
468 PIO_STACK_LOCATION Stack;
469 UCHAR MajorFunction;
470 UCHAR MinorFunction;
471 WORK_QUEUE_ITEM WorkQueueItem;
472 PIRP Irp;
473 BOOLEAN IsTopLevel;
474 PDEVICE_OBJECT DeviceObject;
475 PFILE_OBJECT FileObject;
476 NTSTATUS SavedExceptionCode;
477 CCHAR PriorityBoost;
478 } NTFS_IRP_CONTEXT, *PNTFS_IRP_CONTEXT;
479
480 typedef struct _NTFS_ATTR_CONTEXT
481 {
482 PUCHAR CacheRun;
483 ULONGLONG CacheRunOffset;
484 LONGLONG CacheRunStartLCN;
485 ULONGLONG CacheRunLength;
486 LONGLONG CacheRunLastLCN;
487 ULONGLONG CacheRunCurrentOffset;
488 LARGE_MCB DataRunsMCB;
489 ULONGLONG FileMFTIndex;
490 PNTFS_ATTR_RECORD pRecord;
491 } NTFS_ATTR_CONTEXT, *PNTFS_ATTR_CONTEXT;
492
493 #define FCB_CACHE_INITIALIZED 0x0001
494 #define FCB_IS_VOLUME_STREAM 0x0002
495 #define FCB_IS_VOLUME 0x0004
496 #define MAX_PATH 260
497
498 typedef struct _FCB
499 {
500 NTFSIDENTIFIER Identifier;
501
502 FSRTL_COMMON_FCB_HEADER RFCB;
503 SECTION_OBJECT_POINTERS SectionObjectPointers;
504
505 PFILE_OBJECT FileObject;
506 PNTFS_VCB Vcb;
507
508 WCHAR Stream[MAX_PATH];
509 WCHAR *ObjectName; /* point on filename (250 chars max) in PathName */
510 WCHAR PathName[MAX_PATH]; /* path+filename 260 max */
511
512 ERESOURCE PagingIoResource;
513 ERESOURCE MainResource;
514
515 LIST_ENTRY FcbListEntry;
516 struct _FCB* ParentFcb;
517
518 ULONG DirIndex;
519
520 LONG RefCount;
521 ULONG Flags;
522 ULONG OpenHandleCount;
523
524 ULONGLONG MFTIndex;
525 USHORT LinkCount;
526
527 FILENAME_ATTRIBUTE Entry;
528
529 } NTFS_FCB, *PNTFS_FCB;
530
531 typedef struct _FIND_ATTR_CONTXT
532 {
533 PDEVICE_EXTENSION Vcb;
534 BOOLEAN OnlyResident;
535 PNTFS_ATTR_RECORD FirstAttr;
536 PNTFS_ATTR_RECORD CurrAttr;
537 PNTFS_ATTR_RECORD LastAttr;
538 PNTFS_ATTR_RECORD NonResidentStart;
539 PNTFS_ATTR_RECORD NonResidentEnd;
540 ULONG Offset;
541 } FIND_ATTR_CONTXT, *PFIND_ATTR_CONTXT;
542
543 typedef struct
544 {
545 USHORT USN;
546 USHORT Array[];
547 } FIXUP_ARRAY, *PFIXUP_ARRAY;
548
549 extern PNTFS_GLOBAL_DATA NtfsGlobalData;
550
551 FORCEINLINE
552 NTSTATUS
553 NtfsMarkIrpContextForQueue(PNTFS_IRP_CONTEXT IrpContext)
554 {
555 PULONG Flags = &IrpContext->Flags;
556
557 *Flags &= ~IRPCONTEXT_COMPLETE;
558 *Flags |= IRPCONTEXT_QUEUE;
559
560 return STATUS_PENDING;
561 }
562
563 /* attrib.c */
564
565 //VOID
566 //NtfsDumpAttribute(PATTRIBUTE Attribute);
567
568 NTSTATUS
569 AddBitmap(PNTFS_VCB Vcb,
570 PFILE_RECORD_HEADER FileRecord,
571 PNTFS_ATTR_RECORD AttributeAddress,
572 PCWSTR Name,
573 USHORT NameLength);
574
575 NTSTATUS
576 AddData(PFILE_RECORD_HEADER FileRecord,
577 PNTFS_ATTR_RECORD AttributeAddress);
578
579 NTSTATUS
580 AddRun(PNTFS_VCB Vcb,
581 PNTFS_ATTR_CONTEXT AttrContext,
582 ULONG AttrOffset,
583 PFILE_RECORD_HEADER FileRecord,
584 ULONGLONG NextAssignedCluster,
585 ULONG RunLength);
586
587 NTSTATUS
588 AddIndexAllocation(PNTFS_VCB Vcb,
589 PFILE_RECORD_HEADER FileRecord,
590 PNTFS_ATTR_RECORD AttributeAddress,
591 PCWSTR Name,
592 USHORT NameLength);
593
594 NTSTATUS
595 AddIndexRoot(PNTFS_VCB Vcb,
596 PFILE_RECORD_HEADER FileRecord,
597 PNTFS_ATTR_RECORD AttributeAddress,
598 PINDEX_ROOT_ATTRIBUTE NewIndexRoot,
599 ULONG RootLength,
600 PCWSTR Name,
601 USHORT NameLength);
602
603 NTSTATUS
604 AddFileName(PFILE_RECORD_HEADER FileRecord,
605 PNTFS_ATTR_RECORD AttributeAddress,
606 PDEVICE_EXTENSION DeviceExt,
607 PFILE_OBJECT FileObject,
608 BOOLEAN CaseSensitive,
609 PULONGLONG ParentMftIndex);
610
611 NTSTATUS
612 AddStandardInformation(PFILE_RECORD_HEADER FileRecord,
613 PNTFS_ATTR_RECORD AttributeAddress);
614
615 NTSTATUS
616 ConvertDataRunsToLargeMCB(PUCHAR DataRun,
617 PLARGE_MCB DataRunsMCB,
618 PULONGLONG pNextVBN);
619
620 NTSTATUS
621 ConvertLargeMCBToDataRuns(PLARGE_MCB DataRunsMCB,
622 PUCHAR RunBuffer,
623 ULONG MaxBufferSize,
624 PULONG UsedBufferSize);
625
626 PUCHAR
627 DecodeRun(PUCHAR DataRun,
628 LONGLONG *DataRunOffset,
629 ULONGLONG *DataRunLength);
630
631 ULONG GetFileNameAttributeLength(PFILENAME_ATTRIBUTE FileNameAttribute);
632
633 VOID
634 NtfsDumpDataRuns(PVOID StartOfRun,
635 ULONGLONG CurrentLCN);
636
637 VOID
638 NtfsDumpFileAttributes(PDEVICE_EXTENSION Vcb,
639 PFILE_RECORD_HEADER FileRecord);
640
641 PSTANDARD_INFORMATION
642 GetStandardInformationFromRecord(PDEVICE_EXTENSION Vcb,
643 PFILE_RECORD_HEADER FileRecord);
644
645 PFILENAME_ATTRIBUTE
646 GetFileNameFromRecord(PDEVICE_EXTENSION Vcb,
647 PFILE_RECORD_HEADER FileRecord,
648 UCHAR NameType);
649
650 UCHAR
651 GetPackedByteCount(LONGLONG NumberToPack,
652 BOOLEAN IsSigned);
653
654 NTSTATUS
655 GetLastClusterInDataRun(PDEVICE_EXTENSION Vcb,
656 PNTFS_ATTR_RECORD Attribute,
657 PULONGLONG LastCluster);
658
659 PFILENAME_ATTRIBUTE
660 GetBestFileNameFromRecord(PDEVICE_EXTENSION Vcb,
661 PFILE_RECORD_HEADER FileRecord);
662
663 NTSTATUS
664 FindFirstAttribute(PFIND_ATTR_CONTXT Context,
665 PDEVICE_EXTENSION Vcb,
666 PFILE_RECORD_HEADER FileRecord,
667 BOOLEAN OnlyResident,
668 PNTFS_ATTR_RECORD * Attribute);
669
670 NTSTATUS
671 FindNextAttribute(PFIND_ATTR_CONTXT Context,
672 PNTFS_ATTR_RECORD * Attribute);
673
674 VOID
675 FindCloseAttribute(PFIND_ATTR_CONTXT Context);
676
677 NTSTATUS
678 FreeClusters(PNTFS_VCB Vcb,
679 PNTFS_ATTR_CONTEXT AttrContext,
680 ULONG AttrOffset,
681 PFILE_RECORD_HEADER FileRecord,
682 ULONG ClustersToFree);
683
684 /* blockdev.c */
685
686 NTSTATUS
687 NtfsReadDisk(IN PDEVICE_OBJECT DeviceObject,
688 IN LONGLONG StartingOffset,
689 IN ULONG Length,
690 IN ULONG SectorSize,
691 IN OUT PUCHAR Buffer,
692 IN BOOLEAN Override);
693
694 NTSTATUS
695 NtfsWriteDisk(IN PDEVICE_OBJECT DeviceObject,
696 IN LONGLONG StartingOffset,
697 IN ULONG Length,
698 IN ULONG SectorSize,
699 IN const PUCHAR Buffer);
700
701 NTSTATUS
702 NtfsReadSectors(IN PDEVICE_OBJECT DeviceObject,
703 IN ULONG DiskSector,
704 IN ULONG SectorCount,
705 IN ULONG SectorSize,
706 IN OUT PUCHAR Buffer,
707 IN BOOLEAN Override);
708
709 NTSTATUS
710 NtfsDeviceIoControl(IN PDEVICE_OBJECT DeviceObject,
711 IN ULONG ControlCode,
712 IN PVOID InputBuffer,
713 IN ULONG InputBufferSize,
714 IN OUT PVOID OutputBuffer,
715 IN OUT PULONG OutputBufferSize,
716 IN BOOLEAN Override);
717
718
719 /* btree.c */
720
721 LONG
722 CompareTreeKeys(PB_TREE_KEY Key1,
723 PB_TREE_KEY Key2,
724 BOOLEAN CaseSensitive);
725
726 NTSTATUS
727 CreateBTreeFromIndex(PDEVICE_EXTENSION Vcb,
728 PFILE_RECORD_HEADER FileRecordWithIndex,
729 /*PCWSTR IndexName,*/
730 PNTFS_ATTR_CONTEXT IndexRootContext,
731 PINDEX_ROOT_ATTRIBUTE IndexRoot,
732 PB_TREE *NewTree);
733
734 NTSTATUS
735 CreateIndexRootFromBTree(PDEVICE_EXTENSION DeviceExt,
736 PB_TREE Tree,
737 ULONG MaxIndexSize,
738 PINDEX_ROOT_ATTRIBUTE *IndexRoot,
739 ULONG *Length);
740
741 NTSTATUS
742 DemoteBTreeRoot(PB_TREE Tree);
743
744 VOID
745 DestroyBTree(PB_TREE Tree);
746
747 VOID
748 DestroyBTreeNode(PB_TREE_FILENAME_NODE Node);
749
750 VOID
751 DumpBTree(PB_TREE Tree);
752
753 VOID
754 DumpBTreeKey(PB_TREE Tree,
755 PB_TREE_KEY Key,
756 ULONG Number,
757 ULONG Depth);
758
759 VOID
760 DumpBTreeNode(PB_TREE Tree,
761 PB_TREE_FILENAME_NODE Node,
762 ULONG Number,
763 ULONG Depth);
764
765 NTSTATUS
766 CreateEmptyBTree(PB_TREE *NewTree);
767
768 ULONGLONG
769 GetAllocationOffsetFromVCN(PDEVICE_EXTENSION DeviceExt,
770 ULONG IndexBufferSize,
771 ULONGLONG Vcn);
772
773 ULONGLONG
774 GetIndexEntryVCN(PINDEX_ENTRY_ATTRIBUTE IndexEntry);
775
776 ULONG
777 GetSizeOfIndexEntries(PB_TREE_FILENAME_NODE Node);
778
779 NTSTATUS
780 NtfsInsertKey(PB_TREE Tree,
781 ULONGLONG FileReference,
782 PFILENAME_ATTRIBUTE FileNameAttribute,
783 PB_TREE_FILENAME_NODE Node,
784 BOOLEAN CaseSensitive,
785 ULONG MaxIndexRootSize,
786 ULONG IndexRecordSize,
787 PB_TREE_KEY *MedianKey,
788 PB_TREE_FILENAME_NODE *NewRightHandSibling);
789
790 NTSTATUS
791 SplitBTreeNode(PB_TREE Tree,
792 PB_TREE_FILENAME_NODE Node,
793 PB_TREE_KEY *MedianKey,
794 PB_TREE_FILENAME_NODE *NewRightHandSibling,
795 BOOLEAN CaseSensitive);
796
797 NTSTATUS
798 UpdateIndexAllocation(PDEVICE_EXTENSION DeviceExt,
799 PB_TREE Tree,
800 ULONG IndexBufferSize,
801 PFILE_RECORD_HEADER FileRecord);
802
803 NTSTATUS
804 UpdateIndexNode(PDEVICE_EXTENSION DeviceExt,
805 PFILE_RECORD_HEADER FileRecord,
806 PB_TREE_FILENAME_NODE Node,
807 ULONG IndexBufferSize,
808 PNTFS_ATTR_CONTEXT IndexAllocationContext,
809 ULONG IndexAllocationOffset);
810
811 /* close.c */
812
813 NTSTATUS
814 NtfsCleanup(PNTFS_IRP_CONTEXT IrpContext);
815
816
817 /* close.c */
818
819 NTSTATUS
820 NtfsCloseFile(PDEVICE_EXTENSION DeviceExt,
821 PFILE_OBJECT FileObject);
822
823 NTSTATUS
824 NtfsClose(PNTFS_IRP_CONTEXT IrpContext);
825
826
827 /* create.c */
828
829 NTSTATUS
830 NtfsCreate(PNTFS_IRP_CONTEXT IrpContext);
831
832 NTSTATUS
833 NtfsCreateDirectory(PDEVICE_EXTENSION DeviceExt,
834 PFILE_OBJECT FileObject,
835 BOOLEAN CaseSensitive,
836 BOOLEAN CanWait);
837
838 PFILE_RECORD_HEADER
839 NtfsCreateEmptyFileRecord(PDEVICE_EXTENSION DeviceExt);
840
841 NTSTATUS
842 NtfsCreateFileRecord(PDEVICE_EXTENSION DeviceExt,
843 PFILE_OBJECT FileObject,
844 BOOLEAN CaseSensitive,
845 BOOLEAN CanWait);
846
847 /* devctl.c */
848
849 NTSTATUS
850 NtfsDeviceControl(PNTFS_IRP_CONTEXT IrpContext);
851
852
853 /* dirctl.c */
854
855 ULONGLONG
856 NtfsGetFileSize(PDEVICE_EXTENSION DeviceExt,
857 PFILE_RECORD_HEADER FileRecord,
858 PCWSTR Stream,
859 ULONG StreamLength,
860 PULONGLONG AllocatedSize);
861
862 NTSTATUS
863 NtfsDirectoryControl(PNTFS_IRP_CONTEXT IrpContext);
864
865
866 /* dispatch.c */
867
868 DRIVER_DISPATCH NtfsFsdDispatch;
869 NTSTATUS NTAPI
870 NtfsFsdDispatch(PDEVICE_OBJECT DeviceObject,
871 PIRP Irp);
872
873
874 /* fastio.c */
875
876 BOOLEAN NTAPI
877 NtfsAcqLazyWrite(PVOID Context,
878 BOOLEAN Wait);
879
880 VOID NTAPI
881 NtfsRelLazyWrite(PVOID Context);
882
883 BOOLEAN NTAPI
884 NtfsAcqReadAhead(PVOID Context,
885 BOOLEAN Wait);
886
887 VOID NTAPI
888 NtfsRelReadAhead(PVOID Context);
889
890 FAST_IO_CHECK_IF_POSSIBLE NtfsFastIoCheckIfPossible;
891 FAST_IO_READ NtfsFastIoRead;
892 FAST_IO_WRITE NtfsFastIoWrite;
893
894
895 /* fcb.c */
896
897 PNTFS_FCB
898 NtfsCreateFCB(PCWSTR FileName,
899 PCWSTR Stream,
900 PNTFS_VCB Vcb);
901
902 VOID
903 NtfsDestroyFCB(PNTFS_FCB Fcb);
904
905 BOOLEAN
906 NtfsFCBIsDirectory(PNTFS_FCB Fcb);
907
908 BOOLEAN
909 NtfsFCBIsReparsePoint(PNTFS_FCB Fcb);
910
911 BOOLEAN
912 NtfsFCBIsCompressed(PNTFS_FCB Fcb);
913
914 BOOLEAN
915 NtfsFCBIsRoot(PNTFS_FCB Fcb);
916
917 VOID
918 NtfsGrabFCB(PNTFS_VCB Vcb,
919 PNTFS_FCB Fcb);
920
921 VOID
922 NtfsReleaseFCB(PNTFS_VCB Vcb,
923 PNTFS_FCB Fcb);
924
925 VOID
926 NtfsAddFCBToTable(PNTFS_VCB Vcb,
927 PNTFS_FCB Fcb);
928
929 PNTFS_FCB
930 NtfsGrabFCBFromTable(PNTFS_VCB Vcb,
931 PCWSTR FileName);
932
933 NTSTATUS
934 NtfsFCBInitializeCache(PNTFS_VCB Vcb,
935 PNTFS_FCB Fcb);
936
937 PNTFS_FCB
938 NtfsMakeRootFCB(PNTFS_VCB Vcb);
939
940 PNTFS_FCB
941 NtfsOpenRootFCB(PNTFS_VCB Vcb);
942
943 NTSTATUS
944 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb,
945 PNTFS_FCB Fcb,
946 PFILE_OBJECT FileObject);
947
948 NTSTATUS
949 NtfsGetFCBForFile(PNTFS_VCB Vcb,
950 PNTFS_FCB *pParentFCB,
951 PNTFS_FCB *pFCB,
952 PCWSTR pFileName,
953 BOOLEAN CaseSensitive);
954
955 NTSTATUS
956 NtfsReadFCBAttribute(PNTFS_VCB Vcb,
957 PNTFS_FCB pFCB,
958 ULONG Type,
959 PCWSTR Name,
960 ULONG NameLength,
961 PVOID * Data);
962
963 NTSTATUS
964 NtfsMakeFCBFromDirEntry(PNTFS_VCB Vcb,
965 PNTFS_FCB DirectoryFCB,
966 PUNICODE_STRING Name,
967 PCWSTR Stream,
968 PFILE_RECORD_HEADER Record,
969 ULONGLONG MFTIndex,
970 PNTFS_FCB * fileFCB);
971
972
973 /* finfo.c */
974
975 NTSTATUS
976 NtfsQueryInformation(PNTFS_IRP_CONTEXT IrpContext);
977
978 NTSTATUS
979 NtfsSetEndOfFile(PNTFS_FCB Fcb,
980 PFILE_OBJECT FileObject,
981 PDEVICE_EXTENSION DeviceExt,
982 ULONG IrpFlags,
983 BOOLEAN CaseSensitive,
984 PLARGE_INTEGER NewFileSize);
985
986 NTSTATUS
987 NtfsSetInformation(PNTFS_IRP_CONTEXT IrpContext);
988
989 /* fsctl.c */
990
991 NTSTATUS
992 NtfsFileSystemControl(PNTFS_IRP_CONTEXT IrpContext);
993
994
995 /* mft.c */
996 NTSTATUS
997 NtfsAddFilenameToDirectory(PDEVICE_EXTENSION DeviceExt,
998 ULONGLONG DirectoryMftIndex,
999 ULONGLONG FileReferenceNumber,
1000 PFILENAME_ATTRIBUTE FilenameAttribute,
1001 BOOLEAN CaseSensitive);
1002
1003 NTSTATUS
1004 AddNewMftEntry(PFILE_RECORD_HEADER FileRecord,
1005 PDEVICE_EXTENSION DeviceExt,
1006 PULONGLONG DestinationIndex,
1007 BOOLEAN CanWait);
1008
1009 VOID
1010 NtfsDumpData(ULONG_PTR Buffer, ULONG Length);
1011
1012 PNTFS_ATTR_CONTEXT
1013 PrepareAttributeContext(PNTFS_ATTR_RECORD AttrRecord);
1014
1015 VOID
1016 ReleaseAttributeContext(PNTFS_ATTR_CONTEXT Context);
1017
1018 ULONG
1019 ReadAttribute(PDEVICE_EXTENSION Vcb,
1020 PNTFS_ATTR_CONTEXT Context,
1021 ULONGLONG Offset,
1022 PCHAR Buffer,
1023 ULONG Length);
1024
1025 NTSTATUS
1026 WriteAttribute(PDEVICE_EXTENSION Vcb,
1027 PNTFS_ATTR_CONTEXT Context,
1028 ULONGLONG Offset,
1029 const PUCHAR Buffer,
1030 ULONG Length,
1031 PULONG LengthWritten,
1032 PFILE_RECORD_HEADER FileRecord);
1033
1034 ULONGLONG
1035 AttributeDataLength(PNTFS_ATTR_RECORD AttrRecord);
1036
1037 NTSTATUS
1038 InternalSetResidentAttributeLength(PDEVICE_EXTENSION DeviceExt,
1039 PNTFS_ATTR_CONTEXT AttrContext,
1040 PFILE_RECORD_HEADER FileRecord,
1041 ULONG AttrOffset,
1042 ULONG DataSize);
1043
1044 PNTFS_ATTR_RECORD
1045 MoveAttributes(PDEVICE_EXTENSION DeviceExt,
1046 PNTFS_ATTR_RECORD FirstAttributeToMove,
1047 ULONG FirstAttributeOffset,
1048 ULONG_PTR MoveTo);
1049
1050 NTSTATUS
1051 SetAttributeDataLength(PFILE_OBJECT FileObject,
1052 PNTFS_FCB Fcb,
1053 PNTFS_ATTR_CONTEXT AttrContext,
1054 ULONG AttrOffset,
1055 PFILE_RECORD_HEADER FileRecord,
1056 PLARGE_INTEGER DataSize);
1057
1058 VOID
1059 SetFileRecordEnd(PFILE_RECORD_HEADER FileRecord,
1060 PNTFS_ATTR_RECORD AttrEnd,
1061 ULONG EndMarker);
1062
1063 NTSTATUS
1064 SetNonResidentAttributeDataLength(PDEVICE_EXTENSION Vcb,
1065 PNTFS_ATTR_CONTEXT AttrContext,
1066 ULONG AttrOffset,
1067 PFILE_RECORD_HEADER FileRecord,
1068 PLARGE_INTEGER DataSize);
1069
1070 NTSTATUS
1071 SetResidentAttributeDataLength(PDEVICE_EXTENSION Vcb,
1072 PNTFS_ATTR_CONTEXT AttrContext,
1073 ULONG AttrOffset,
1074 PFILE_RECORD_HEADER FileRecord,
1075 PLARGE_INTEGER DataSize);
1076
1077 ULONGLONG
1078 AttributeAllocatedLength(PNTFS_ATTR_RECORD AttrRecord);
1079
1080 BOOLEAN
1081 CompareFileName(PUNICODE_STRING FileName,
1082 PINDEX_ENTRY_ATTRIBUTE IndexEntry,
1083 BOOLEAN DirSearch,
1084 BOOLEAN CaseSensitive);
1085
1086 NTSTATUS
1087 UpdateMftMirror(PNTFS_VCB Vcb);
1088
1089 NTSTATUS
1090 ReadFileRecord(PDEVICE_EXTENSION Vcb,
1091 ULONGLONG index,
1092 PFILE_RECORD_HEADER file);
1093
1094 NTSTATUS
1095 UpdateIndexEntryFileNameSize(PDEVICE_EXTENSION Vcb,
1096 PFILE_RECORD_HEADER MftRecord,
1097 PCHAR IndexRecord,
1098 ULONG IndexBlockSize,
1099 PINDEX_ENTRY_ATTRIBUTE FirstEntry,
1100 PINDEX_ENTRY_ATTRIBUTE LastEntry,
1101 PUNICODE_STRING FileName,
1102 PULONG StartEntry,
1103 PULONG CurrentEntry,
1104 BOOLEAN DirSearch,
1105 ULONGLONG NewDataSize,
1106 ULONGLONG NewAllocatedSize,
1107 BOOLEAN CaseSensitive);
1108
1109 NTSTATUS
1110 UpdateFileNameRecord(PDEVICE_EXTENSION Vcb,
1111 ULONGLONG ParentMFTIndex,
1112 PUNICODE_STRING FileName,
1113 BOOLEAN DirSearch,
1114 ULONGLONG NewDataSize,
1115 ULONGLONG NewAllocationSize,
1116 BOOLEAN CaseSensitive);
1117
1118 NTSTATUS
1119 UpdateFileRecord(PDEVICE_EXTENSION Vcb,
1120 ULONGLONG MftIndex,
1121 PFILE_RECORD_HEADER FileRecord);
1122
1123 NTSTATUS
1124 FindAttribute(PDEVICE_EXTENSION Vcb,
1125 PFILE_RECORD_HEADER MftRecord,
1126 ULONG Type,
1127 PCWSTR Name,
1128 ULONG NameLength,
1129 PNTFS_ATTR_CONTEXT * AttrCtx,
1130 PULONG Offset);
1131
1132 VOID
1133 ReadVCN(PDEVICE_EXTENSION Vcb,
1134 PFILE_RECORD_HEADER file,
1135 ATTRIBUTE_TYPE type,
1136 ULONGLONG vcn,
1137 ULONG count,
1138 PVOID buffer);
1139
1140 NTSTATUS
1141 FixupUpdateSequenceArray(PDEVICE_EXTENSION Vcb,
1142 PNTFS_RECORD_HEADER Record);
1143
1144 NTSTATUS
1145 AddFixupArray(PDEVICE_EXTENSION Vcb,
1146 PNTFS_RECORD_HEADER Record);
1147
1148 NTSTATUS
1149 ReadLCN(PDEVICE_EXTENSION Vcb,
1150 ULONGLONG lcn,
1151 ULONG count,
1152 PVOID buffer);
1153
1154 VOID
1155 EnumerAttribute(PFILE_RECORD_HEADER file,
1156 PDEVICE_EXTENSION Vcb,
1157 PDEVICE_OBJECT DeviceObject);
1158
1159 NTSTATUS
1160 NtfsLookupFile(PDEVICE_EXTENSION Vcb,
1161 PUNICODE_STRING PathName,
1162 BOOLEAN CaseSensitive,
1163 PFILE_RECORD_HEADER *FileRecord,
1164 PULONGLONG MFTIndex);
1165
1166 NTSTATUS
1167 NtfsLookupFileAt(PDEVICE_EXTENSION Vcb,
1168 PUNICODE_STRING PathName,
1169 BOOLEAN CaseSensitive,
1170 PFILE_RECORD_HEADER *FileRecord,
1171 PULONGLONG MFTIndex,
1172 ULONGLONG CurrentMFTIndex);
1173
1174 VOID
1175 NtfsDumpFileRecord(PDEVICE_EXTENSION Vcb,
1176 PFILE_RECORD_HEADER FileRecord);
1177
1178 NTSTATUS
1179 NtfsFindFileAt(PDEVICE_EXTENSION Vcb,
1180 PUNICODE_STRING SearchPattern,
1181 PULONG FirstEntry,
1182 PFILE_RECORD_HEADER *FileRecord,
1183 PULONGLONG MFTIndex,
1184 ULONGLONG CurrentMFTIndex,
1185 BOOLEAN CaseSensitive);
1186
1187 NTSTATUS
1188 NtfsFindMftRecord(PDEVICE_EXTENSION Vcb,
1189 ULONGLONG MFTIndex,
1190 PUNICODE_STRING FileName,
1191 PULONG FirstEntry,
1192 BOOLEAN DirSearch,
1193 BOOLEAN CaseSensitive,
1194 ULONGLONG *OutMFTIndex);
1195
1196 /* misc.c */
1197
1198 BOOLEAN
1199 NtfsIsIrpTopLevel(PIRP Irp);
1200
1201 PNTFS_IRP_CONTEXT
1202 NtfsAllocateIrpContext(PDEVICE_OBJECT DeviceObject,
1203 PIRP Irp);
1204
1205 PVOID
1206 NtfsGetUserBuffer(PIRP Irp,
1207 BOOLEAN Paging);
1208
1209 NTSTATUS
1210 NtfsLockUserBuffer(IN PIRP Irp,
1211 IN ULONG Length,
1212 IN LOCK_OPERATION Operation);
1213
1214 #if 0
1215 BOOLEAN
1216 wstrcmpjoki(PWSTR s1, PWSTR s2);
1217
1218 VOID
1219 CdfsSwapString(PWCHAR Out,
1220 PUCHAR In,
1221 ULONG Count);
1222 #endif
1223
1224 VOID
1225 NtfsFileFlagsToAttributes(ULONG NtfsAttributes,
1226 PULONG FileAttributes);
1227
1228
1229 /* rw.c */
1230
1231 NTSTATUS
1232 NtfsRead(PNTFS_IRP_CONTEXT IrpContext);
1233
1234 NTSTATUS
1235 NtfsWrite(PNTFS_IRP_CONTEXT IrpContext);
1236
1237
1238 /* volinfo.c */
1239
1240 NTSTATUS
1241 NtfsAllocateClusters(PDEVICE_EXTENSION DeviceExt,
1242 ULONG FirstDesiredCluster,
1243 ULONG DesiredClusters,
1244 PULONG FirstAssignedCluster,
1245 PULONG AssignedClusters);
1246
1247 ULONGLONG
1248 NtfsGetFreeClusters(PDEVICE_EXTENSION DeviceExt);
1249
1250 NTSTATUS
1251 NtfsQueryVolumeInformation(PNTFS_IRP_CONTEXT IrpContext);
1252
1253 NTSTATUS
1254 NtfsSetVolumeInformation(PNTFS_IRP_CONTEXT IrpContext);
1255
1256
1257 /* ntfs.c */
1258
1259 DRIVER_INITIALIZE DriverEntry;
1260
1261 VOID
1262 NTAPI
1263 NtfsInitializeFunctionPointers(PDRIVER_OBJECT DriverObject);
1264
1265 #endif /* NTFS_H */