reactos/drivers/filesystems/fastfat_new/fatstruc.h

   1 #ifndef __STRUCT_H__
   2 #define __STRUCT_H__
   3
   4 typedef struct _FAT_SCAN_CONTEXT *PFAT_SCAN_CONTEXT;
   5 typedef struct _FAT_IO_CONTEXT *PFAT_IO_CONTEXT;
   6 typedef struct _FAT_IRP_CONTEXT *PFAT_IRP_CONTEXT;
   7 typedef PVOID PBCB;
   8
   9 typedef NTSTATUS (*PFAT_OPERATION_HANDLER) (PFAT_IRP_CONTEXT);
  10
  11 /* Node type stuff */
  12 typedef CSHORT FAT_NODE_TYPE;
  13 typedef FAT_NODE_TYPE *PFAT_NODE_TYPE;
  14
  15 #define FatNodeType(Ptr) (*((PFAT_NODE_TYPE)(Ptr)))
  16
  17 /* Node type codes */
  18 #define FAT_NTC_VCB      (CSHORT) '00VF'
  19 #define FAT_NTC_FCB      (CSHORT)   'CF'
  20 #define FAT_NTC_DCB      (CSHORT)   'DF'
  21 #define FAT_NTC_ROOT_DCB (CSHORT)  'RFD'
  22
  23 typedef struct _FAT_GLOBAL_DATA
  24 {
  25     ERESOURCE Resource;
  26     PDRIVER_OBJECT DriverObject;
  27     PDEVICE_OBJECT DiskDeviceObject;
  28     LIST_ENTRY VcbListHead;
  29     NPAGED_LOOKASIDE_LIST NonPagedFcbList;
  30     NPAGED_LOOKASIDE_LIST ResourceList;
  31     NPAGED_LOOKASIDE_LIST IrpContextList;
  32     FAST_IO_DISPATCH FastIoDispatch;
  33     CACHE_MANAGER_CALLBACKS CacheMgrCallbacks;
  34     CACHE_MANAGER_CALLBACKS CacheMgrNoopCallbacks;
  35     BOOLEAN Win31FileSystem;
  36     /* Jan 1, 1980 System Time */
  37     LARGE_INTEGER DefaultFileTime;
  38
  39     /* FullFAT integration */
  40     FF_IOMAN *Ioman;
  41     FF_ERROR FF_Error;
  42 } FAT_GLOBAL_DATA;
  43
  44 typedef struct _FAT_PAGE_CONTEXT
  45 {
  46     PFILE_OBJECT FileObject;
  47     LARGE_INTEGER EndOfData;
  48     LARGE_INTEGER Offset;
  49     LARGE_INTEGER EndOfPage;
  50     SIZE_T ValidLength;
  51     PVOID Buffer;
  52     PBCB Bcb;
  53     BOOLEAN CanWait;
  54 } FAT_PAGE_CONTEXT, *PFAT_PAGE_CONTEXT;
  55
  56 #define FatPinSetupContext(xContext, xFcb, CanWait)     \
  57 {                                                       \
  58     (xContext)->FileObject = (xFcb)->StreamFileObject;  \
  59     (xContext)->EndOfData = (xFcb)->Header.FileSize;    \
  60     (xContext)->Offset.QuadPart = -1LL;                 \
  61     (xContext)->Bcb = NULL;                             \
  62     (xContext)->CanWait = CanWait;                      \
  63 }
  64
  65 #define FatPinCleanupContext(xContext)                  \
  66     if ((xContext)->Bcb != NULL) {                      \
  67         CcUnpinData((xContext)->Bcb);                   \
  68         (xContext)->Bcb = NULL;                         \
  69     }                                                   \
  70
  71 #define FatPinEndOfPage(xContext, xType) \
  72     Add2Ptr((xContext)->Buffer, (xContext)->ValidLength, xType)
  73
  74 #define FatPinIsLastPage(xContext) \
  75     ((xContext)->ValidLength != PAGE_SIZE)
  76
  77 #define IRPCONTEXT_CANWAIT          0x0001
  78 #define IRPCONTEXT_PENDINGRETURNED  0x0002
  79 #define IRPCONTEXT_STACK_IO_CONTEXT 0x0004
  80 #define IRPCONTEXT_WRITETHROUGH         0x0008
  81 #define IRPCONTEXT_TOPLEVEL                     0x0010
  82
  83 typedef struct _FAT_IRP_CONTEXT
  84 {
  85     PIRP Irp;
  86     PDEVICE_OBJECT DeviceObject;
  87     UCHAR MajorFunction;
  88     UCHAR MinorFunction;
  89     PFILE_OBJECT FileObject;
  90     ULONG Flags;
  91     struct _VCB *Vcb;
  92     ULONG PinCount;
  93     FAT_PAGE_CONTEXT Page;
  94     struct _FAT_IO_CONTEXT *FatIoContext;
  95     WORK_QUEUE_ITEM WorkQueueItem;
  96     PFAT_OPERATION_HANDLER QueuedOperationHandler;
  97     PIO_STACK_LOCATION Stack;
  98     KEVENT Event;
  99 } FAT_IRP_CONTEXT;
 100
 101 typedef struct _FAT_IO_CONTEXT
 102 {
 103     PMDL ZeroMdl;
 104     PIRP Irp;
 105     LONG RunCount;
 106     SIZE_T Length;
 107     LONGLONG Offset;
 108     PFILE_OBJECT FileObject;
 109
 110     union
 111     {
 112         struct
 113         {
 114             PERESOURCE Resource;
 115             PERESOURCE PagingIoResource;
 116             ERESOURCE_THREAD ResourceThreadId;
 117         } Async;
 118         KEVENT SyncEvent;
 119     } Wait;
 120     PIRP AssociatedIrp[0];
 121 } FAT_IO_CONTEXT;
 122
 123 typedef ULONG (*PFAT_SCANFAT_FOR_CONTINOUS_RUN_ROUTINE) (PFAT_PAGE_CONTEXT, PULONG, BOOLEAN);
 124 typedef ULONG (*PFAT_SETFAT_CONTINOUS_RUN_ROUTINE) (PFAT_PAGE_CONTEXT, ULONG, ULONG, BOOLEAN);
 125 typedef ULONG (*PFAT_SCANFAT_FOR_VALUE_RUN_ROUTINE) (PFAT_PAGE_CONTEXT, PULONG, ULONG, BOOLEAN);
 126 typedef ULONG (*PFAT_SETFAT_VALUE_RUN_ROUTINE) (PFAT_PAGE_CONTEXT, ULONG, ULONG, ULONG, BOOLEAN);
 127
 128 typedef struct _FAT_METHODS {
 129     PFAT_SCANFAT_FOR_CONTINOUS_RUN_ROUTINE ScanContinousRun;
 130     PFAT_SETFAT_CONTINOUS_RUN_ROUTINE SetContinousRun;
 131     PFAT_SCANFAT_FOR_VALUE_RUN_ROUTINE ScanValueRun;
 132     PFAT_SETFAT_VALUE_RUN_ROUTINE SetValueRun;
 133 } FAT_METHODS, *PFAT_METHODS;
 134
 135 #define VCB_STATE_FLAG_LOCKED 0x01
 136
 137 typedef enum _VCB_CONDITION
 138 {
 139     VcbGood,
 140     VcbNotMounted,
 141     VcbBad
 142 } VCB_CONDITION;
 143
 144 /* Volume Control Block */
 145 typedef struct _VCB
 146 {
 147     FSRTL_ADVANCED_FCB_HEADER Header;
 148     FAST_MUTEX HeaderMutex;
 149     SECTION_OBJECT_POINTERS SectionObjectPointers;
 150
 151     PFILE_OBJECT StreamFileObject;
 152     PDEVICE_OBJECT TargetDeviceObject;
 153     LIST_ENTRY VcbLinks;
 154     PVPB Vpb;
 155     ULONG State;
 156     VCB_CONDITION Condition;
 157     ERESOURCE Resource;
 158
 159     /* Notifications support */
 160     PNOTIFY_SYNC NotifySync;
 161     LIST_ENTRY NotifyList;
 162
 163     /*  Volume Characteristics: */
 164     ULONG SerialNumber;
 165     BIOS_PARAMETER_BLOCK Bpb;
 166     ULONG BytesPerClusterLog;
 167     ULONG BytesPerCluster;
 168     ULONG SectorsPerFat;
 169     ULONG DataArea;
 170     ULONG Sectors;
 171     ULONG Clusters;
 172     ULONG IndexDepth;
 173     ULONG RootDirent;
 174     ULONG RootDirentSectors;
 175     LONGLONG BeyondLastClusterInFat;
 176     FAT_METHODS Methods;
 177
 178     /*  Root Directory Control block */
 179     struct _FCB *RootDcb;
 180
 181     ULONG MediaChangeCount;
 182
 183     /* FullFAT integration */
 184     FF_IOMAN *Ioman;
 185 } VCB, *PVCB;
 186
 187 #define VcbToVolumeDeviceObject(xVcb) \
 188     CONTAINING_RECORD((xVcb), VOLUME_DEVICE_OBJECT, Vcb))
 189
 190 #define VcbToDeviceObject(xVcb) \
 191     &(VcbToVolumeDeviceObject(xVcb)->DeviceObject)
 192
 193
 194 #define SectorsToBytes(xVcb, xSectrors) \
 195         ((xVcb)->Bpb.BytesPerSector * (xSectrors))
 196
 197 #define BytesToSectors(xVcb, xBytes) \
 198         ((xBytes + (xVcb)->Bpb.BytesPerSector - 1) / (xVcb)->Bpb.BytesPerSector)
 199
 200 #define SectorsToClusters(xVcb, xSectors) \
 201         ((xSectors + (xVcb)->Bpb.SectorsPerCluster - 1) / (xVcb)->Bpb.SectorsPerCluster)
 202
 203 #define VCB_FAT_BITMAP_SIZE                             0x10000
 204 #define VcbFatBitmapIndex(xCluster)             ((xCluster)/VCB_FAT_BITMAP_SIZE)
 205
 206 /* Volume Device Object */
 207 typedef struct _VOLUME_DEVICE_OBJECT
 208 {
 209     DEVICE_OBJECT DeviceObject;
 210     union {
 211         FSRTL_COMMON_FCB_HEADER VolumeHeader;
 212         VCB Vcb; /* Must be the last entry! */
 213     };
 214 } VOLUME_DEVICE_OBJECT, *PVOLUME_DEVICE_OBJECT;
 215 //
 216 //  Short name always exists in FAT
 217 //
 218 enum _FCB_NAME_TYPE {
 219     FcbShortName = 0x0,
 220     FcbLongName
 221 } FCB_NAME_TYPE;
 222
 223 typedef struct _FCB_NAME_LINK {
 224     RTL_SPLAY_LINKS Links;
 225     union
 226     {
 227         OEM_STRING Ansi;
 228         UNICODE_STRING String;
 229     } Name;
 230     UCHAR Type;
 231 } FCB_NAME_LINK, *PFCB_NAME_LINK;
 232
 233 typedef enum _FCB_CONDITION
 234 {
 235     FcbGood,
 236     FcbBad,
 237     FcbNeedsToBeVerified
 238 } FCB_CONDITION;
 239
 240 typedef struct _FCB
 241 {
 242     FSRTL_ADVANCED_FCB_HEADER Header;
 243    /*
 244     * Later we might want to move the next four fields
 245     * into a separate structureif we decide to split
 246     * FCB into paged and non paged parts
 247     * (as it is done in MS implementation
 248     */
 249     FAST_MUTEX HeaderMutex; // nonpaged!
 250     SECTION_OBJECT_POINTERS SectionObjectPointers;
 251     ERESOURCE Resource; // nonpaged!
 252     ERESOURCE PagingIoResource; // nonpaged!
 253
 254     FILE_LOCK Lock;
 255     /* First cluster in the fat allocation chain */
 256     ULONG FirstClusterOfFile;
 257     /* A list of all FCBs of that DCB */
 258     LIST_ENTRY ParentDcbLinks;
 259     /* Reference to the Parent Dcb*/
 260     struct _FCB *ParentFcb;
 261     /* Pointer to a Vcb */
 262     PVCB Vcb;
 263     /* Fcb state */
 264     ULONG State;
 265     /* Fcb condition */
 266     FCB_CONDITION Condition;
 267     /* Mcb mapping Vbo->Lbo */
 268     LARGE_MCB Mcb;
 269     ULONG FirstCluster;
 270     /* Links into FCB Trie */
 271     FCB_NAME_LINK FileName;
 272     /* Buffer for the short name */
 273     WCHAR ShortNameBuffer[0xc];
 274     /* Full file name */
 275     UNICODE_STRING FullFileName;
 276     /* A copy of fat attribute byte */
 277     UCHAR DirentFatFlags;
 278     /* File basic info */
 279     FILE_BASIC_INFORMATION BasicInfo;
 280     union
 281     {
 282         struct
 283         {
 284             /* A list of all FCBs/DCBs opened under this DCB */
 285             LIST_ENTRY ParentDcbList;
 286             /* Directory data stream (just handy to have it). */
 287             PFILE_OBJECT StreamFileObject;
 288             /* Bitmap to search for free dirents. */
 289             RTL_BITMAP FreeBitmap;
 290             PRTL_SPLAY_LINKS SplayLinks;
 291         } Dcb;
 292     };
 293 } FCB, *PFCB;
 294
 295 typedef struct _FAT_ENUM_DIRENT_CONTEXT *PFAT_ENUM_DIRENT_CONTEXT;
 296 typedef struct _FAT_ENUM_DIR_CONTEXT *PFAT_ENUM_DIR_CONTEXT;
 297
 298 typedef ULONG (*PFAT_COPY_DIRENT_ROUTINE) (PFAT_ENUM_DIR_CONTEXT, PDIR_ENTRY, PVOID);
 299
 300 typedef struct _FAT_ENUM_DIRENT_CONTEXT
 301 {
 302     FAT_PAGE_CONTEXT Page;
 303
 304     /* Copy dirent to dirinfo */
 305     PFAT_COPY_DIRENT_ROUTINE CopyDirent;
 306     LONGLONG BytesPerClusterMask;
 307
 308     /* Info buffer characteristics */
 309     PVOID Buffer;
 310     SIZE_T Offset;
 311     SIZE_T Length;
 312
 313     /* Criteria */
 314     PUNICODE_STRING FileName;
 315     UCHAR CcbFlags;
 316
 317     /* Lfn buffer/length offsets */
 318     ULONG LengthOffset;
 319     ULONG NameOffset;
 320 } FAT_ENUM_DIRENT_CONTEXT;
 321
 322 typedef struct _FAT_FIND_DIRENT_CONTEXT
 323 {
 324     FAT_PAGE_CONTEXT Page;
 325     UNICODE_STRING ShortName;
 326     WCHAR ShortNameBuffer[0x18];
 327     /* Criteria */
 328     PUNICODE_STRING FileName;
 329     BOOLEAN Valid8dot3Name;
 330 } FAT_FIND_DIRENT_CONTEXT, *PFAT_FIND_DIRENT_CONTEXT;
 331
 332 typedef struct _CCB
 333 {
 334     LARGE_INTEGER CurrentByteOffset;
 335     ULONG Entry;
 336     UNICODE_STRING SearchPattern;
 337     UCHAR Flags;
 338 } CCB, *PCCB;
 339
 340 typedef enum _TYPE_OF_OPEN
 341 {
 342     UnopenedFileObject,
 343     UserFileOpen,
 344     UserDirectoryOpen,
 345     UserVolumeOpen,
 346     VirtualVolumeFile,
 347     DirectoryFile,
 348     EaFile
 349 } TYPE_OF_OPEN;
 350
 351 #define CCB_SEARCH_RETURN_SINGLE_ENTRY      0x01
 352 #define CCB_SEARCH_PATTERN_LEGAL_8DOT3      0x02
 353 #define CCB_SEARCH_PATTERN_HAS_WILD_CARD    0x04
 354 #define CCB_DASD_IO                         0x10
 355 extern FAT_GLOBAL_DATA FatGlobalData;
 356
 357 #endif//__STRUCT_H__