Driver.h

Go to the documentation of this file.

 
#ifndef DRIVER_H
#define DRIVER_H
 
#define NTFS_MAX_MFT            4096
#define NTFS_MAX_IDX            16384
#define COMPRESSION_BLOCK       4096
#define NTFS_DRIVER_VERSION     0x00020000
#define MAX_PATH                1024
#define MINIMUM_INFO_LENGTH     (sizeof (EFI_FILE_INFO) + MAX_PATH * sizeof(CHAR16))
#define MINIMUM_FS_INFO_LENGTH  (sizeof (EFI_FILE_SYSTEM_INFO) + MAX_PATH * sizeof(CHAR16))
#define ATTRIBUTES_END_MARKER   0xFFFFFFFF
#define MAX_FILE_SIZE           (MAX_UINT32 & ~7ULL)
#define S_FILENAME              0x3
#define S_SYMLINK               0xC
 
enum {
  AT_STANDARD_INFORMATION = 0x10,
  AT_ATTRIBUTE_LIST       = 0x20,
  AT_FILENAME             = 0x30,
  AT_VOLUME_VERSION       = 0x40,
  AT_SECURITY_DESCRIPTOR  = 0x50,
  AT_VOLUME_NAME          = 0x60,
  AT_VOLUME_INFORMATION   = 0x70,
  AT_DATA                 = 0x80,
  AT_INDEX_ROOT           = 0x90,
  AT_INDEX_ALLOCATION     = 0xA0,
  AT_BITMAP               = 0xB0,
  AT_SYMLINK              = 0xC0,
  AT_EA_INFORMATION       = 0xD0,
  AT_EA                   = 0xE0,
  AT_PROPERTY_SET         = 0xF0,
};
 
enum {
  ATTR_READ_ONLY   = 0x1,
  ATTR_HIDDEN      = 0x2,
  ATTR_SYSTEM      = 0x4,
  ATTR_ARCHIVE     = 0x20,
  ATTR_DEVICE      = 0x40,
  ATTR_NORMAL      = 0x80,
  ATTR_TEMPORARY   = 0x100,
  ATTR_SPARSE      = 0x200,
  ATTR_REPARSE     = 0x400,
  ATTR_COMPRESSED  = 0x800,
  ATTR_OFFLINE     = 0x1000,
  ATTR_NOT_INDEXED = 0x2000,
  ATTR_ENCRYPTED   = 0x4000,
  ATTR_DIRECTORY   = 0x10000000,
  ATTR_INDEX_VIEW  = 0x20000000
};
 
enum {
  MFT_FILE     =  0,
  MFTMIRR_FILE =  1,
  LOGFILE_FILE =  2,
  VOLUME_FILE  =  3,
  ATTRDEF_FILE =  4,
  ROOT_FILE    =  5,
  BITMAP_FILE  =  6,
  BOOT_FILE    =  7,
  BADCLUS_FILE =  8,
  QUOTA_FILE   =  9,
  UPCASE_FILE  = 10,
};
 
enum {
  NTFS_AF_ALST     = 1,
  NTFS_AF_MFT_FILE = 2,
  NTFS_AF_GPOS     = 4,
};
 
enum {
  FLAG_COMPRESSED = 0x0001,
  FLAG_ENCRYPTED  = 0x4000,
  FLAG_SPARSE     = 0x8000
};
 
enum {
  IS_IN_USE       = 0x01,
  IS_A_DIRECTORY  = 0x02,
  IS_AN_EXTENSION = 0x04,
  IS_A_SPECIAL    = 0x08,
 
  IS_SUPPORTED_FLAGS =    IS_IN_USE
                       | IS_A_DIRECTORY
                       | IS_AN_EXTENSION
                       | IS_A_SPECIAL,
};
 
enum {
  SUB_NODE         = 0x01,
  LAST_INDEX_ENTRY = 0x02,
};
 
enum {
  POSIX     = 0,
  WINDOWS32 = 1,
  DOS       = 2,
  WIN32_DOS = 3,
};
 
enum {
  IS_ALIAS        = 0x20000000,
  IS_HIGH_LATENCY = 0x40000000,
  IS_MICROSOFT    = 0x80000000,
  NSS             = 0x68000005,
  NSS_RECOVER     = 0x68000006,
  SIS             = 0x68000007,
  DFS             = 0x68000008,
  MOUNT_POINT     = 0x88000003,
  HSM             = 0xA8000004,
  SYMBOLIC_LINK   = 0xE8000000,
};
 
#pragma pack(1)
 
typedef struct {
  UINT32    Magic;
  UINT16    UpdateSequenceOffset;
  UINT16    S_Size;
  UINT64    LSN;
  UINT16    SequenceNumber;
  UINT16    HardLinkCount;
  UINT16    AttributeOffset;
  UINT16    Flags;
  UINT32    RealSize;
  UINT32    AllocatedSize;
  UINT64    BaseFileRecord;
  UINT16    NextAttributeId;
} FILE_RECORD_HEADER;
 
typedef struct {
  UINT32    Type;
  UINT32    Length;
  UINT8     NonResFlag;
  UINT8     NameLength;
  UINT16    NameOffset;
  UINT16    Flags;
  UINT16    AttributeId;
  UINT32    InfoLength;
  UINT16    InfoOffset;
  UINT8     IndexedFlag;
  UINT8     Padding;
} ATTR_HEADER_RES;
 
typedef struct {
  UINT32    Type;
  UINT32    Length;
  UINT8     NonResFlag;
  UINT8     NameLength;
  UINT16    NameOffset;
  UINT16    Flags;
  UINT16    AttributeId;
  UINT64    StartingVCN;
  UINT64    LastVCN;
  UINT16    DataRunsOffset;
  UINT16    CompressionUnitSize;
  UINT32    Padding;
  UINT64    AllocatedSize;
  UINT64    RealSize;
  UINT64    InitializedDataSize;
} ATTR_HEADER_NONRES;
 
typedef struct {
  UINT32    Type;
  UINT16    RecordLength;
  UINT8     NameLength;
  UINT8     NameOffset;
  UINT64    StartingVCN;
  UINT64    BaseFileReference;
  UINT16    AttributeId;
} ATTR_LIST_RECORD;
 
typedef struct {
  UINT8     FileRecordNumber[6];
  UINT16    SequenceNumber;
  UINT16    IndexEntryLength;
  UINT16    StreamLength;
  UINT8     Flags;
  UINT8     Padding[3];
} INDEX_ENTRY;
 
typedef struct {
  UINT32    Magic;
  UINT16    UpdateSequenceOffset;
  UINT16    S_Size;
  UINT64    LSN;
  UINT64    IndexRecordVCN;
} INDEX_HEADER;
 
typedef struct {
  INDEX_HEADER    Header;
  UINT32          IndexEntriesOffset;
  UINT32          IndexEntriesSize;
  UINT32          IndexEntriesAllocated;
  UINT8           IsNotLeafNode;
  UINT8           Padding[3];
} INDEX_RECORD_HEADER;
 
typedef struct {
  UINT32    Type;
  UINT32    CollationRule;
  UINT32    IndexAllocationSize;
  UINT8     IndexRecordClusters;
  UINT8     Padding[3];
} INDEX_ROOT;
 
typedef struct {
  INDEX_ROOT    Root;
  UINT32        FirstEntryOffset;
  UINT32        EntriesTotalSize;
  UINT32        EntriesAllocatedSize;
  UINT8         Flags;
  UINT8         Padding[3];
} ATTR_INDEX_ROOT;
 
typedef struct {
  UINT64    ParentDir;
  UINT64    CreationTime;
  UINT64    AlteredTime;
  UINT64    ChangedMftTime;
  UINT64    ReadTime;
  UINT64    AllocatedSize;
  UINT64    RealSize;
  UINT32    Flags;
  UINT32    Reparse;
  UINT8     FilenameLen;
  UINT8     Namespace;
} ATTR_FILE_NAME;
 
typedef struct {
  UINT8     BootLoaderJump[3];
  UINT32    SystemId[2];
  UINT16    BytesPerSector;
  UINT8     SectorsPerCluster;
  UINT8     Unused1[7];
  UINT8     MediaDescriptor;
  UINT16    Unused2;
  UINT16    SectorsPerTrack;
  UINT16    HeadsNumber;
  UINT64    Unused3;
  UINT32    Usually;
  UINT64    VolumeSectorsNumber;
  UINT64    MftLcn;
  UINT64    MftMirrLcn;
  INT8      MftRecordClusters;
  UINT8     Unused4[3];
  INT8      IndexRecordClusters;
  UINT8     Unused5[3];
  UINT64    VolumeSerialNumber;
} BOOT_FILE_DATA;
 
typedef struct {
  UINT32    Type;
  UINT16    DataLength;
  UINT16    Padding;
  UINT16    SubstituteOffset;
  UINT16    SubstituteLength;
  UINT16    PrintOffset;
  UINT16    PrintLength;
} SYMLINK;
#pragma pack()
 
typedef struct _NTFS_FILE      NTFS_FILE;
typedef struct _EFI_NTFS_FILE  EFI_NTFS_FILE;
typedef struct _EFI_FS         EFI_FS;
 
typedef struct {
  INT32        Flags;
  UINT8        *ExtensionMftRecord;
  UINT8        *NonResAttrList;
  UINT8        *Current;
  UINT8        *Next;
  UINT8        *Last;
  NTFS_FILE    *BaseMftRecord;
} NTFS_ATTR;
 
typedef struct _NTFS_FILE {
  UINT8            *FileRecord;
  UINT64           DataAttributeSize;
  UINT64           CreationTime;
  UINT64           AlteredTime;
  UINT64           ReadTime;
  UINT64           Inode;
  BOOLEAN          InodeRead;
  NTFS_ATTR        Attr;
  EFI_NTFS_FILE    *File;
} NTFS_FILE;
 
typedef struct _EFI_NTFS_FILE {
  EFI_FILE_PROTOCOL    EfiFile;
  BOOLEAN              IsDir;
  UINT64               DirIndex;
  CHAR16               *Path;
  CHAR16               *BaseName;
  UINT64               Offset;
  UINT32               RefCount;
  NTFS_FILE            RootFile;
  NTFS_FILE            MftFile;
  EFI_FS               *FileSystem;
} EFI_NTFS_FILE;
 
typedef struct _EFI_FS {
  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL    FileIoInterface;
  EFI_FILE_PROTOCOL                  EfiFile;
  EFI_BLOCK_IO_PROTOCOL              *BlockIo;
  EFI_DISK_IO_PROTOCOL               *DiskIo;
  EFI_DEVICE_PATH                    *DevicePath;
  UINT64                             FirstMftRecord;
  NTFS_FILE                          *RootIndex;
  NTFS_FILE                          *MftStart;
  UINTN                              FileRecordSize;
  UINTN                              IndexRecordSize;
  UINTN                              SectorSize;
  UINTN                              ClusterSize;
 
  //
  // CFI = Cache for FileInfo
  //
  UINTN                              CFIDataSize;
  VOID                               *CFIData;
  UINT64                             CFIHash;
  INT64                              CFIDirIndex;
} EFI_FS;
 
typedef struct {
  UINT64    Vcn;
  UINT64    Lcn;
} UNIT_ELEMENT;
 
typedef struct {
  EFI_FS          *FileSystem;
  UINT8           Head;
  UINT8           Tail;
  UNIT_ELEMENT    Elements[16];
  UINT64          CurrentVcn;
  UINT8           *Cluster;
  UINTN           ClusterOffset;
  UINT64          SavedPosition;
  UINT8           *ClearTextBlock;
} COMPRESSED;
 
typedef struct {
  BOOLEAN       IsSparse;
  UINT64        TargetVcn;
  UINT64        CurrentVcn;
  UINT64        CurrentLcn;
  UINT64        NextVcn;
  UINT8         *NextDataRun;
  NTFS_ATTR     *Attr;
  COMPRESSED    Unit;
} RUNLIST;
 
#endif // DRIVER_H