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