[NTFS]
[reactos.git] / reactos / drivers / filesystems / ntfs / ntfs.h
1 #ifndef NTFS_H
2 #define NTFS_H
3
4 #include <ntifs.h>
5
6 #define CACHEPAGESIZE(pDeviceExt) \
7 ((pDeviceExt)->NtfsInfo.UCHARsPerCluster > PAGE_SIZE ? \
8 (pDeviceExt)->NtfsInfo.UCHARsPerCluster : PAGE_SIZE)
9
10 #define TAG_NTFS 'SFTN'
11
12 #define ROUND_UP(N, S) ((((N) + (S) - 1) / (S)) * (S))
13
14 #define DEVICE_NAME L"\\Ntfs"
15
16 #include <pshpack1.h>
17 typedef struct _BIOS_PARAMETERS_BLOCK
18 {
19 USHORT BytesPerSector; // 0x0B
20 UCHAR SectorsPerCluster; // 0x0D
21 UCHAR Unused0[7]; // 0x0E, checked when volume is mounted
22 UCHAR MediaId; // 0x15
23 UCHAR Unused1[2]; // 0x16
24 USHORT SectorsPerTrack; // 0x18
25 USHORT Heads; // 0x1A
26 UCHAR Unused2[4]; // 0x1C
27 UCHAR Unused3[4]; // 0x20, checked when volume is mounted
28 } BIOS_PARAMETERS_BLOCK, *PBIOS_PARAMETERS_BLOCK;
29
30 typedef struct _EXTENDED_BIOS_PARAMETERS_BLOCK
31 {
32 USHORT Unknown[2]; // 0x24, always 80 00 80 00
33 ULONGLONG SectorCount; // 0x28
34 ULONGLONG MftLocation; // 0x30
35 ULONGLONG MftMirrLocation; // 0x38
36 CHAR ClustersPerMftRecord; // 0x40
37 UCHAR Unused4[3]; // 0x41
38 CHAR ClustersPerIndexRecord; // 0x44
39 UCHAR Unused5[3]; // 0x45
40 ULONGLONG SerialNumber; // 0x48
41 UCHAR Checksum[4]; // 0x50
42 } EXTENDED_BIOS_PARAMETERS_BLOCK, *PEXTENDED_BIOS_PARAMETERS_BLOCK;
43
44 typedef struct _BOOT_SECTOR
45 {
46 UCHAR Jump[3]; // 0x00
47 UCHAR OEMID[8]; // 0x03
48 BIOS_PARAMETERS_BLOCK BPB;
49 EXTENDED_BIOS_PARAMETERS_BLOCK EBPB;
50 UCHAR BootStrap[426]; // 0x54
51 USHORT EndSector; // 0x1FE
52 } BOOT_SECTOR, *PBOOT_SECTOR;
53 #include <poppack.h>
54
55 //typedef struct _BootSector BootSector;
56
57 typedef struct _NTFS_INFO
58 {
59 ULONG BytesPerSector;
60 ULONG SectorsPerCluster;
61 ULONG BytesPerCluster;
62 ULONGLONG SectorCount;
63 ULARGE_INTEGER MftStart;
64 ULARGE_INTEGER MftMirrStart;
65 ULONG BytesPerFileRecord;
66 ULONG BytesPerIndexRecord;
67
68 ULONGLONG SerialNumber;
69 USHORT VolumeLabelLength;
70 WCHAR VolumeLabel[MAXIMUM_VOLUME_LABEL_LENGTH];
71 UCHAR MajorVersion;
72 UCHAR MinorVersion;
73 USHORT Flags;
74
75 } NTFS_INFO, *PNTFS_INFO;
76
77 #define NTFS_TYPE_CCB '20SF'
78 #define NTFS_TYPE_FCB '30SF'
79 #define NTFS_TYPE_VCB '50SF'
80 #define NTFS_TYPE_IRP_CONTEST '60SF'
81 #define NTFS_TYPE_GLOBAL_DATA '70SF'
82
83 typedef struct
84 {
85 ULONG Type;
86 ULONG Size;
87 } NTFSIDENTIFIER, *PNTFSIDENTIFIER;
88
89
90 typedef struct
91 {
92 NTFSIDENTIFIER Identifier;
93
94 ERESOURCE DirResource;
95 // ERESOURCE FatResource;
96
97 KSPIN_LOCK FcbListLock;
98 LIST_ENTRY FcbListHead;
99
100 PVPB Vpb;
101 PDEVICE_OBJECT StorageDevice;
102 PFILE_OBJECT StreamFileObject;
103
104 struct _FCB *VolumeFcb;
105
106 NTFS_INFO NtfsInfo;
107
108 } DEVICE_EXTENSION, *PDEVICE_EXTENSION, NTFS_VCB, *PNTFS_VCB;
109
110
111 #define FCB_CACHE_INITIALIZED 0x0001
112 #define FCB_IS_VOLUME_STREAM 0x0002
113 #define FCB_IS_VOLUME 0x0004
114 #define MAX_PATH 260
115
116 typedef struct _FCB
117 {
118 NTFSIDENTIFIER Identifier;
119
120 FSRTL_COMMON_FCB_HEADER RFCB;
121 SECTION_OBJECT_POINTERS SectionObjectPointers;
122
123 PFILE_OBJECT FileObject;
124 PNTFS_VCB Vcb;
125
126 WCHAR *ObjectName; /* point on filename (250 chars max) in PathName */
127 WCHAR PathName[MAX_PATH]; /* path+filename 260 max */
128
129 ERESOURCE PagingIoResource;
130 ERESOURCE MainResource;
131
132 LIST_ENTRY FcbListEntry;
133 struct _FCB* ParentFcb;
134
135 ULONG DirIndex;
136
137 LONG RefCount;
138 ULONG Flags;
139
140 // DIR_RECORD Entry;
141
142 } NTFS_FCB, *PNTFS_FCB;
143
144
145 typedef struct
146 {
147 NTFSIDENTIFIER Identifier;
148 LIST_ENTRY NextCCB;
149 PFILE_OBJECT PtrFileObject;
150 LARGE_INTEGER CurrentByteOffset;
151 /* for DirectoryControl */
152 ULONG Entry;
153 /* for DirectoryControl */
154 PWCHAR DirectorySearchPattern;
155 ULONG LastCluster;
156 ULONG LastOffset;
157 } NTFS_CCB, *PNTFS_CCB;
158
159 #define TAG_CCB 'BCCI'
160
161 typedef struct
162 {
163 NTFSIDENTIFIER Identifier;
164 ERESOURCE Resource;
165 PDRIVER_OBJECT DriverObject;
166 PDEVICE_OBJECT DeviceObject;
167 CACHE_MANAGER_CALLBACKS CacheMgrCallbacks;
168 ULONG Flags;
169 } NTFS_GLOBAL_DATA, *PNTFS_GLOBAL_DATA;
170
171
172 typedef enum
173 {
174 AttributeStandardInformation = 0x10,
175 AttributeAttributeList = 0x20,
176 AttributeFileName = 0x30,
177 AttributeObjectId = 0x40,
178 AttributeSecurityDescriptor = 0x50,
179 AttributeVolumeName = 0x60,
180 AttributeVolumeInformation = 0x70,
181 AttributeData = 0x80,
182 AttributeIndexRoot = 0x90,
183 AttributeIndexAllocation = 0xA0,
184 AttributeBitmap = 0xB0,
185 AttributeReparsePoint = 0xC0,
186 AttributeEAInformation = 0xD0,
187 AttributeEA = 0xE0,
188 AttributePropertySet = 0xF0,
189 AttributeLoggedUtilityStream = 0x100
190 } ATTRIBUTE_TYPE, *PATTRIBUTE_TYPE;
191
192 #define COLLATION_BINARY 0x00
193 #define COLLATION_FILE_NAME 0x01
194 #define COLLATION_UNICODE_STRING 0x02
195 #define COLLATION_NTOFS_ULONG 0x10
196 #define COLLATION_NTOFS_SID 0x11
197 #define COLLATION_NTOFS_SECURITY_HASH 0x12
198 #define COLLATION_NTOFS_ULONGS 0x13
199
200 #define INDEX_ROOT_SMALL 0x0
201 #define INDEX_ROOT_LARGE 0x1
202
203 typedef struct
204 {
205 ULONG Type; /* Magic number 'FILE' */
206 USHORT UsaOffset; /* Offset to the update sequence */
207 USHORT UsaCount; /* Size in words of Update Sequence Number & Array (S) */
208 ULONGLONG Lsn; /* $LogFile Sequence Number (LSN) */
209 } NTFS_RECORD_HEADER, *PNTFS_RECORD_HEADER;
210
211 /* NTFS_RECORD_HEADER.Type */
212 #define NRH_FILE_TYPE 0x454C4946 /* 'FILE' */
213
214
215 typedef struct
216 {
217 NTFS_RECORD_HEADER Ntfs;
218 USHORT SequenceNumber; /* Sequence number */
219 USHORT LinkCount; /* Hard link count */
220 USHORT AttributeOffset; /* Offset to the first Attribute */
221 USHORT Flags; /* Flags */
222 ULONG BytesInUse; /* Real size of the FILE record */
223 ULONG BytesAllocated; /* Allocated size of the FILE record */
224 ULONGLONG BaseFileRecord; /* File reference to the base FILE record */
225 USHORT NextAttributeNumber; /* Next Attribute Id */
226 USHORT Pading; /* Align to 4 UCHAR boundary (XP) */
227 ULONG MFTRecordNumber; /* Number of this MFT Record (XP) */
228 } FILE_RECORD_HEADER, *PFILE_RECORD_HEADER;
229
230 /* Flags in FILE_RECORD_HEADER */
231
232 #define FRH_IN_USE 0x0001 /* Record is in use */
233 #define FRH_DIRECTORY 0x0002 /* Record is a directory */
234 #define FRH_UNKNOWN1 0x0004 /* Don't know */
235 #define FRH_UNKNOWN2 0x0008 /* Don't know */
236
237 typedef struct
238 {
239 ATTRIBUTE_TYPE AttributeType;
240 ULONG Length;
241 BOOLEAN Nonresident;
242 UCHAR NameLength;
243 USHORT NameOffset;
244 USHORT Flags;
245 USHORT AttributeNumber;
246 } ATTRIBUTE, *PATTRIBUTE;
247
248 typedef struct
249 {
250 ATTRIBUTE Attribute;
251 ULONG ValueLength;
252 USHORT ValueOffset;
253 UCHAR Flags;
254 // UCHAR Padding0;
255 } RESIDENT_ATTRIBUTE, *PRESIDENT_ATTRIBUTE;
256
257 typedef struct
258 {
259 ATTRIBUTE Attribute;
260 ULONGLONG StartVcn; // LowVcn
261 ULONGLONG LastVcn; // HighVcn
262 USHORT RunArrayOffset;
263 USHORT CompressionUnit;
264 ULONG Padding0;
265 UCHAR IndexedFlag;
266 ULONGLONG AllocatedSize;
267 ULONGLONG DataSize;
268 ULONGLONG InitializedSize;
269 ULONGLONG CompressedSize;
270 } NONRESIDENT_ATTRIBUTE, *PNONRESIDENT_ATTRIBUTE;
271
272
273 typedef struct
274 {
275 ULONGLONG CreationTime;
276 ULONGLONG ChangeTime;
277 ULONGLONG LastWriteTime;
278 ULONGLONG LastAccessTime;
279 ULONG FileAttribute;
280 ULONG AlignmentOrReserved[3];
281 #if 0
282 ULONG QuotaId;
283 ULONG SecurityId;
284 ULONGLONG QuotaCharge;
285 USN Usn;
286 #endif
287 } STANDARD_INFORMATION, *PSTANDARD_INFORMATION;
288
289
290 typedef struct
291 {
292 ATTRIBUTE_TYPE AttributeType;
293 USHORT Length;
294 UCHAR NameLength;
295 UCHAR NameOffset;
296 ULONGLONG StartVcn; // LowVcn
297 ULONGLONG FileReferenceNumber;
298 USHORT AttributeNumber;
299 USHORT AlignmentOrReserved[3];
300 } ATTRIBUTE_LIST, *PATTRIBUTE_LIST;
301
302
303 typedef struct
304 {
305 ULONGLONG DirectoryFileReferenceNumber;
306 ULONGLONG CreationTime;
307 ULONGLONG ChangeTime;
308 ULONGLONG LastWriteTime;
309 ULONGLONG LastAccessTime;
310 ULONGLONG AllocatedSize;
311 ULONGLONG DataSize;
312 ULONG FileAttributes;
313 ULONG AlignmentOrReserved;
314 UCHAR NameLength;
315 UCHAR NameType;
316 WCHAR Name[1];
317 } FILENAME_ATTRIBUTE, *PFILENAME_ATTRIBUTE;
318
319 typedef struct
320 {
321 ULONG FirstEntryOffset;
322 ULONG TotalSizeOfEntries;
323 ULONG AllocatedSize;
324 UCHAR Flags;
325 UCHAR Padding[3];
326 } INDEX_HEADER_ATTRIBUTE, *PINDEX_HEADER_ATTRIBUTE;
327
328 typedef struct
329 {
330 ULONG AttributeType;
331 ULONG CollationRule;
332 ULONG SizeOfEntry;
333 UCHAR ClustersPerIndexRecord;
334 UCHAR Padding[3];
335 INDEX_HEADER_ATTRIBUTE Header;
336 } INDEX_ROOT_ATTRIBUTE, *PINDEX_ROOT_ATTRIBUTE;
337
338 typedef struct
339 {
340 ULONGLONG Unknown1;
341 UCHAR MajorVersion;
342 UCHAR MinorVersion;
343 USHORT Flags;
344 ULONG Unknown2;
345 } VOLINFO_ATTRIBUTE, *PVOLINFO_ATTRIBUTE;
346
347 typedef struct
348 {
349 NTFSIDENTIFIER Identifier;
350 ULONG Flags;
351 UCHAR MajorFunction;
352 UCHAR MinorFunction;
353 WORK_QUEUE_ITEM WorkQueueItem;
354 PIRP Irp;
355 BOOLEAN IsTopLevel;
356 PDEVICE_OBJECT DeviceObject;
357 NTSTATUS SavedExceptionCode;
358 } NTFS_IRP_CONTEXT, *PNTFS_IRP_CONTEXT;
359
360
361 extern PNTFS_GLOBAL_DATA NtfsGlobalData;
362
363 //int CdfsStrcmpi( wchar_t *str1, wchar_t *str2 );
364 //void CdfsWstrcpy( wchar_t *str1, wchar_t *str2, int max );
365
366
367 /* attrib.c */
368
369 //VOID
370 //NtfsDumpAttribute(PATTRIBUTE Attribute);
371
372 //LONGLONG RunLCN(PUCHAR run);
373
374 //ULONG RunLength(PUCHAR run);
375
376 BOOLEAN
377 FindRun(PNONRESIDENT_ATTRIBUTE NresAttr,
378 ULONGLONG vcn,
379 PULONGLONG lcn,
380 PULONGLONG count);
381
382 VOID
383 NtfsDumpFileAttributes(PFILE_RECORD_HEADER FileRecord);
384
385
386 /* blockdev.c */
387
388 NTSTATUS
389 NtfsReadSectors(IN PDEVICE_OBJECT DeviceObject,
390 IN ULONG DiskSector,
391 IN ULONG SectorCount,
392 IN ULONG SectorSize,
393 IN OUT PUCHAR Buffer,
394 IN BOOLEAN Override);
395
396 NTSTATUS
397 NtfsDeviceIoControl(IN PDEVICE_OBJECT DeviceObject,
398 IN ULONG ControlCode,
399 IN PVOID InputBuffer,
400 IN ULONG InputBufferSize,
401 IN OUT PVOID OutputBuffer,
402 IN OUT PULONG OutputBufferSize,
403 IN BOOLEAN Override);
404
405
406 /* close.c */
407
408 DRIVER_DISPATCH NtfsFsdClose;
409 NTSTATUS NTAPI
410 NtfsFsdClose(PDEVICE_OBJECT DeviceObject,
411 PIRP Irp);
412
413
414 /* create.c */
415
416 DRIVER_DISPATCH NtfsFsdCreate;
417 NTSTATUS NTAPI
418 NtfsFsdCreate(PDEVICE_OBJECT DeviceObject,
419 PIRP Irp);
420
421
422 /* dirctl.c */
423
424 DRIVER_DISPATCH NtfsFsdDirectoryControl;
425 NTSTATUS NTAPI
426 NtfsFsdDirectoryControl(PDEVICE_OBJECT DeviceObject,
427 PIRP Irp);
428
429
430 /* dispatch.c */
431
432 DRIVER_DISPATCH NtfsFsdDispatch;
433 NTSTATUS NTAPI
434 NtfsFsdDispatch(PDEVICE_OBJECT DeviceObject,
435 PIRP Irp);
436
437
438 /* fastio.c */
439
440 BOOLEAN NTAPI
441 NtfsAcqLazyWrite(PVOID Context,
442 BOOLEAN Wait);
443
444 VOID NTAPI
445 NtfsRelLazyWrite(PVOID Context);
446
447 BOOLEAN NTAPI
448 NtfsAcqReadAhead(PVOID Context,
449 BOOLEAN Wait);
450
451 VOID NTAPI
452 NtfsRelReadAhead(PVOID Context);
453
454
455 /* fcb.c */
456
457 PNTFS_FCB
458 NtfsCreateFCB(PCWSTR FileName,
459 PNTFS_VCB Vcb);
460
461 VOID
462 NtfsDestroyFCB(PNTFS_FCB Fcb);
463
464 BOOLEAN
465 NtfsFCBIsDirectory(PNTFS_FCB Fcb);
466
467 BOOLEAN
468 NtfsFCBIsRoot(PNTFS_FCB Fcb);
469
470 VOID
471 NtfsGrabFCB(PNTFS_VCB Vcb,
472 PNTFS_FCB Fcb);
473
474 VOID
475 NtfsReleaseFCB(PNTFS_VCB Vcb,
476 PNTFS_FCB Fcb);
477
478 VOID
479 NtfsAddFCBToTable(PNTFS_VCB Vcb,
480 PNTFS_FCB Fcb);
481
482 PNTFS_FCB
483 NtfsGrabFCBFromTable(PNTFS_VCB Vcb,
484 PCWSTR FileName);
485
486 NTSTATUS
487 NtfsFCBInitializeCache(PNTFS_VCB Vcb,
488 PNTFS_FCB Fcb);
489
490 PNTFS_FCB
491 NtfsMakeRootFCB(PNTFS_VCB Vcb);
492
493 PNTFS_FCB
494 NtfsOpenRootFCB(PNTFS_VCB Vcb);
495
496 NTSTATUS
497 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb,
498 PNTFS_FCB Fcb,
499 PFILE_OBJECT FileObject);
500
501 NTSTATUS
502 NtfsGetFCBForFile(PNTFS_VCB Vcb,
503 PNTFS_FCB *pParentFCB,
504 PNTFS_FCB *pFCB,
505 const PWSTR pFileName);
506
507
508 /* finfo.c */
509
510 DRIVER_DISPATCH NtfsFsdQueryInformation;
511 NTSTATUS NTAPI
512 NtfsFsdQueryInformation(PDEVICE_OBJECT DeviceObject,
513 PIRP Irp);
514
515
516 /* fsctl.c */
517
518 DRIVER_DISPATCH NtfsFsdFileSystemControl;
519 NTSTATUS NTAPI
520 NtfsFsdFileSystemControl(PDEVICE_OBJECT DeviceObject,
521 PIRP Irp);
522
523
524 /* mft.c */
525 NTSTATUS
526 NtfsOpenMft(PDEVICE_EXTENSION Vcb);
527
528
529 VOID
530 ReadAttribute(PATTRIBUTE attr,
531 PVOID buffer,
532 PDEVICE_EXTENSION Vcb,
533 PDEVICE_OBJECT DeviceObject);
534
535 ULONG
536 AttributeDataLength(PATTRIBUTE attr);
537
538 ULONG
539 AttributeAllocatedLength(PATTRIBUTE Attribute);
540
541 NTSTATUS
542 ReadFileRecord(PDEVICE_EXTENSION Vcb,
543 ULONG index,
544 PFILE_RECORD_HEADER file,
545 PFILE_RECORD_HEADER Mft);
546
547 PATTRIBUTE
548 FindAttribute(PFILE_RECORD_HEADER file,
549 ATTRIBUTE_TYPE type,
550 PWSTR name);
551
552 ULONG
553 AttributeLengthAllocated(PATTRIBUTE attr);
554
555 VOID
556 ReadVCN(PDEVICE_EXTENSION Vcb,
557 PFILE_RECORD_HEADER file,
558 ATTRIBUTE_TYPE type,
559 ULONGLONG vcn,
560 ULONG count,
561 PVOID buffer);
562
563 VOID
564 FixupUpdateSequenceArray(PFILE_RECORD_HEADER file);
565
566 VOID
567 ReadExternalAttribute(PDEVICE_EXTENSION Vcb,
568 PNONRESIDENT_ATTRIBUTE NresAttr,
569 ULONGLONG vcn,
570 ULONG count,
571 PVOID buffer);
572
573 NTSTATUS
574 ReadLCN(PDEVICE_EXTENSION Vcb,
575 ULONGLONG lcn,
576 ULONG count,
577 PVOID buffer);
578
579 VOID
580 EnumerAttribute(PFILE_RECORD_HEADER file,
581 PDEVICE_EXTENSION Vcb,
582 PDEVICE_OBJECT DeviceObject);
583
584
585 /* misc.c */
586
587 BOOLEAN
588 NtfsIsIrpTopLevel(PIRP Irp);
589
590 PNTFS_IRP_CONTEXT
591 NtfsAllocateIrpContext(PDEVICE_OBJECT DeviceObject,
592 PIRP Irp);
593
594 #if 0
595 BOOLEAN
596 wstrcmpjoki(PWSTR s1, PWSTR s2);
597
598 VOID
599 CdfsSwapString(PWCHAR Out,
600 PUCHAR In,
601 ULONG Count);
602
603 VOID
604 CdfsDateTimeToFileTime(PFCB Fcb,
605 TIME *FileTime);
606
607 VOID
608 CdfsFileFlagsToAttributes(PFCB Fcb,
609 PULONG FileAttributes);
610 #endif
611
612
613 /* rw.c */
614
615 DRIVER_DISPATCH NtfsFsdRead;
616 NTSTATUS NTAPI
617 NtfsFsdRead(PDEVICE_OBJECT DeviceObject,
618 PIRP Irp);
619
620 DRIVER_DISPATCH NtfsFsdWrite;
621 NTSTATUS NTAPI
622 NtfsFsdWrite(PDEVICE_OBJECT DeviceObject,
623 PIRP Irp);
624
625
626 /* volinfo.c */
627
628 NTSTATUS
629 NtfsQueryVolumeInformation(PNTFS_IRP_CONTEXT IrpContext);
630
631 NTSTATUS
632 NtfsSetVolumeInformation(PNTFS_IRP_CONTEXT IrpContext);
633
634
635 /* ntfs.c */
636
637 DRIVER_INITIALIZE DriverEntry;
638
639 VOID
640 NTAPI
641 NtfsInitializeFunctionPointers(PDRIVER_OBJECT DriverObject);
642
643 #endif /* NTFS_H */