drivers/fs/vfat/vfat.h

   1 /* $Id$ */
   2
   3 #include <ddk/ntifs.h>
   4
   5 #define ROUND_UP(N, S) ((((N) + (S) - 1) / (S)) * (S))
   6 #define ROUND_DOWN(N, S) ((N) - ((N) % (S)))
   7
   8 struct _BootSector
   9 {
  10   unsigned char  magic0, res0, magic1;
  11   unsigned char  OEMName[8];
  12   unsigned short BytesPerSector;
  13   unsigned char  SectorsPerCluster;
  14   unsigned short ReservedSectors;
  15   unsigned char  FATCount;
  16   unsigned short RootEntries, Sectors;
  17   unsigned char  Media;
  18   unsigned short FATSectors, SectorsPerTrack, Heads;
  19   unsigned long  HiddenSectors, SectorsHuge;
  20   unsigned char  Drive, Res1, Sig;
  21   unsigned long  VolumeID;
  22   unsigned char  VolumeLabel[11], SysType[8];
  23   unsigned char  Res2[446];
  24   unsigned long  Signatur1;
  25 } __attribute__((packed));
  26
  27 struct _BootSector32
  28 {
  29   unsigned char  magic0, res0, magic1;                  // 0
  30   unsigned char  OEMName[8];                            // 3
  31   unsigned short BytesPerSector;                        // 11
  32   unsigned char  SectorsPerCluster;                     // 13
  33   unsigned short ReservedSectors;                       // 14
  34   unsigned char  FATCount;                              // 16
  35   unsigned short RootEntries, Sectors;                  // 17
  36   unsigned char  Media;                                 // 21
  37   unsigned short FATSectors, SectorsPerTrack, Heads;    // 22
  38   unsigned long  HiddenSectors, SectorsHuge;            // 28
  39   unsigned long  FATSectors32;                          // 36
  40   unsigned short ExtFlag;                               // 40
  41   unsigned short FSVersion;                             // 42
  42   unsigned long  RootCluster;                           // 44
  43   unsigned short FSInfoSector;                          // 48
  44   unsigned short BootBackup;                            // 50
  45   unsigned char  Res3[12];                              // 52
  46   unsigned char  Drive;                                 // 64
  47   unsigned char  Res4;                                  // 65
  48   unsigned char  ExtBootSignature;                      // 66
  49   unsigned long  VolumeID;                              // 67
  50   unsigned char  VolumeLabel[11], SysType[8];           // 71
  51   unsigned char  Res2[418];                             // 90
  52   unsigned long  Signature1;                            // 508
  53 } __attribute__((packed));
  54
  55 struct _FsInfoSector
  56 {
  57   unsigned long  ExtBootSignature2;                     // 0
  58   unsigned char  Res6[480];                             // 4
  59   unsigned long  FSINFOSignature;                       // 484
  60   unsigned long  FreeCluster;                           // 488
  61   unsigned long  NextCluster;                           // 492
  62   unsigned char  Res7[12];                              // 496
  63   unsigned long  Signatur2;                             // 508
  64 } __attribute__((packed));
  65
  66 typedef struct _BootSector BootSector;
  67
  68 #define VFAT_CASE_LOWER_BASE    8                       // base is lower case
  69 #define VFAT_CASE_LOWER_EXT     16                      // extension is lower case
  70
  71 struct _FATDirEntry
  72 {
  73   unsigned char  Filename[8], Ext[3];
  74   unsigned char  Attrib;
  75   unsigned char  lCase;
  76   unsigned char  CreationTimeMs;
  77   unsigned short CreationTime,CreationDate,AccessDate;
  78   unsigned short FirstClusterHigh;                      // higher
  79   unsigned short UpdateTime;                            //time create/update
  80   unsigned short UpdateDate;                            //date create/update
  81   unsigned short FirstCluster;
  82   unsigned long  FileSize;
  83 } __attribute__((packed));
  84
  85 typedef struct _FATDirEntry FATDirEntry, FAT_DIR_ENTRY, *PFAT_DIR_ENTRY;
  86
  87 struct _slot
  88 {
  89   unsigned char id;               // sequence number for slot
  90   WCHAR  name0_4[5];              // first 5 characters in name
  91   unsigned char attr;             // attribute byte
  92   unsigned char reserved;         // always 0
  93   unsigned char alias_checksum;   // checksum for 8.3 alias
  94   WCHAR  name5_10[6];             // 6 more characters in name
  95   unsigned char start[2];         // starting cluster number
  96   WCHAR  name11_12[2];            // last 2 characters in name
  97 } __attribute__((packed));
  98
  99
 100 typedef struct _slot slot;
 101
 102 #define BLOCKSIZE 512
 103
 104 #define FAT16 (1)
 105 #define FAT12 (2)
 106 #define FAT32 (3)
 107
 108 #define VCB_VOLUME_LOCKED       0x0001
 109 #define VCB_DISMOUNT_PENDING    0x0002
 110
 111 typedef struct
 112 {
 113   ULONG VolumeID;
 114   ULONG FATStart;
 115   ULONG FATCount;
 116   ULONG FATSectors;
 117   ULONG rootDirectorySectors;
 118   ULONG rootStart;
 119   ULONG dataStart;
 120   ULONG RootCluster;
 121   ULONG SectorsPerCluster;
 122   ULONG BytesPerSector;
 123   ULONG BytesPerCluster;
 124   ULONG NumberOfClusters;
 125   ULONG FatType;
 126   ULONG Sectors;
 127 } FATINFO, *PFATINFO;
 128
 129 struct _VFATFCB;
 130
 131 typedef struct _HASHENTRY
 132 {
 133   ULONG Hash;
 134   struct _VFATFCB* self;
 135   struct _HASHENTRY* next;
 136 }
 137 HASHENTRY;
 138
 139 #define FCB_HASH_TABLE_SIZE 1024
 140
 141 typedef struct
 142 {
 143   ERESOURCE DirResource;
 144   ERESOURCE FatResource;
 145
 146   KSPIN_LOCK FcbListLock;
 147   LIST_ENTRY FcbListHead;
 148
 149   PDEVICE_OBJECT StorageDevice;
 150   PFILE_OBJECT FATFileObject;
 151   FATINFO FatInfo;
 152   ULONG LastAvailableCluster;
 153   ULONG AvailableClusters;
 154   BOOLEAN AvailableClustersValid;
 155   ULONG Flags;
 156   struct _VFATFCB * VolumeFcb;
 157   struct _HASHENTRY* FcbHashTable[FCB_HASH_TABLE_SIZE];
 158
 159   LIST_ENTRY VolumeListEntry;
 160 } DEVICE_EXTENSION, *PDEVICE_EXTENSION, VCB, *PVCB;
 161
 162 typedef struct
 163 {
 164   PDRIVER_OBJECT DriverObject;
 165   PDEVICE_OBJECT DeviceObject;
 166   ULONG Flags;
 167   ERESOURCE VolumeListLock;
 168   LIST_ENTRY VolumeListHead;
 169   NPAGED_LOOKASIDE_LIST FcbLookasideList;
 170   NPAGED_LOOKASIDE_LIST CcbLookasideList;
 171   NPAGED_LOOKASIDE_LIST IrpContextLookasideList;
 172 } VFAT_GLOBAL_DATA, *PVFAT_GLOBAL_DATA;
 173
 174 extern PVFAT_GLOBAL_DATA VfatGlobalData;
 175
 176 #define FCB_CACHE_INITIALIZED   0x0001
 177 #define FCB_DELETE_PENDING      0x0002
 178 #define FCB_IS_FAT              0x0004
 179 #define FCB_IS_PAGE_FILE        0x0008
 180 #define FCB_IS_VOLUME           0x0010
 181
 182 typedef struct _VFATFCB
 183 {
 184   REACTOS_COMMON_FCB_HEADER RFCB;
 185   SECTION_OBJECT_POINTERS SectionObjectPointers;
 186   FATDirEntry entry;
 187   /* point on filename (250 chars max) in PathName */
 188   WCHAR *ObjectName;
 189   /* path+filename 260 max */
 190   WCHAR PathName[MAX_PATH];
 191   WCHAR ShortName[14];
 192   LONG RefCount;
 193   PDEVICE_EXTENSION pDevExt;
 194   LIST_ENTRY FcbListEntry;
 195   struct _VFATFCB* parentFcb;
 196   ULONG Flags;
 197   PFILE_OBJECT FileObject;
 198   ULONG dirIndex;
 199   ULONG startIndex;
 200   ERESOURCE PagingIoResource;
 201   ERESOURCE MainResource;
 202   ULONG TimerCount;
 203   SHARE_ACCESS FCBShareAccess;
 204   HASHENTRY Hash;
 205   HASHENTRY ShortHash;
 206   FILE_LOCK FileLock;
 207
 208   /* Structure members used only for paging files. */
 209   ULONG FatChainSize;
 210   PULONG FatChain;
 211 } VFATFCB, *PVFATFCB;
 212
 213 typedef struct _VFATCCB
 214 {
 215   VFATFCB *   pFcb;
 216   LIST_ENTRY     NextCCB;
 217   PFILE_OBJECT   PtrFileObject;
 218   LARGE_INTEGER  CurrentByteOffset;
 219   /* for DirectoryControl */
 220   ULONG Entry;
 221   /* for DirectoryControl */
 222   PWCHAR DirectorySearchPattern;
 223   ULONG LastCluster;
 224   ULONG LastOffset;
 225
 226 } VFATCCB, *PVFATCCB;
 227
 228 #ifndef TAG
 229 #define TAG(A, B, C, D) (ULONG)(((A)<<0) + ((B)<<8) + ((C)<<16) + ((D)<<24))
 230 #endif
 231
 232 #define TAG_CCB TAG('V', 'C', 'C', 'B')
 233 #define TAG_FCB TAG('V', 'F', 'C', 'B')
 234 #define TAG_IRP TAG('V', 'I', 'R', 'P')
 235
 236 #define ENTRIES_PER_SECTOR (BLOCKSIZE / sizeof(FATDirEntry))
 237
 238 typedef struct __DOSTIME
 239 {
 240    WORD Second:5;
 241    WORD Minute:6;
 242    WORD Hour:5;
 243 }
 244 DOSTIME, *PDOSTIME;
 245
 246 typedef struct __DOSDATE
 247 {
 248    WORD Day:5;
 249    WORD Month:4;
 250    WORD Year:5;
 251 }
 252 DOSDATE, *PDOSDATE;
 253
 254 #define IRPCONTEXT_CANWAIT  0x0001
 255
 256 typedef struct
 257 {
 258    PIRP Irp;
 259    PDEVICE_OBJECT DeviceObject;
 260    PDEVICE_EXTENSION DeviceExt;
 261    ULONG Flags;
 262    WORK_QUEUE_ITEM WorkQueueItem;
 263    PIO_STACK_LOCATION Stack;
 264    UCHAR MajorFunction;
 265    UCHAR MinorFunction;
 266    PFILE_OBJECT FileObject;
 267 } VFAT_IRP_CONTEXT, *PVFAT_IRP_CONTEXT;
 268
 269 /*  ------------------------------------------------------  shutdown.c  */
 270
 271 NTSTATUS STDCALL VfatShutdown (PDEVICE_OBJECT DeviceObject,
 272                                PIRP Irp);
 273
 274 /*  --------------------------------------------------------  volume.c  */
 275
 276 NTSTATUS VfatQueryVolumeInformation (PVFAT_IRP_CONTEXT IrpContext);
 277
 278 NTSTATUS VfatSetVolumeInformation (PVFAT_IRP_CONTEXT IrpContext);
 279
 280 /*  ------------------------------------------------------  blockdev.c  */
 281
 282 NTSTATUS VfatReadDisk(IN PDEVICE_OBJECT pDeviceObject,
 283                       IN PLARGE_INTEGER ReadOffset,
 284                       IN ULONG ReadLength,
 285                       IN PUCHAR Buffer);
 286
 287 NTSTATUS VfatWriteDisk(IN PDEVICE_OBJECT pDeviceObject,
 288                        IN PLARGE_INTEGER WriteOffset,
 289                        IN ULONG WriteLength,
 290                        IN PUCHAR Buffer);
 291
 292 NTSTATUS VfatBlockDeviceIoControl (IN PDEVICE_OBJECT DeviceObject,
 293                                    IN ULONG CtlCode,
 294                                    IN PVOID InputBuffer,
 295                                    IN ULONG InputBufferSize,
 296                                    IN OUT PVOID OutputBuffer,
 297                                    IN OUT PULONG pOutputBufferSize);
 298
 299 /*  -----------------------------------------------------------  dir.c  */
 300
 301 NTSTATUS VfatDirectoryControl (PVFAT_IRP_CONTEXT);
 302
 303 BOOL FsdDosDateTimeToFileTime (WORD wDosDate,
 304                                WORD wDosTime,
 305                                TIME *FileTime);
 306
 307 BOOL FsdFileTimeToDosDateTime (TIME *FileTime,
 308                                WORD *pwDosDate,
 309                                WORD *pwDosTime);
 310
 311 /*  --------------------------------------------------------  create.c  */
 312
 313 NTSTATUS VfatCreate (PVFAT_IRP_CONTEXT IrpContext);
 314
 315 NTSTATUS VfatOpenFile (PDEVICE_EXTENSION DeviceExt,
 316                        PFILE_OBJECT FileObject,
 317                        PWSTR FileName);
 318
 319 NTSTATUS FindFile (PDEVICE_EXTENSION DeviceExt,
 320                    PVFATFCB Fcb,
 321                    PVFATFCB Parent,
 322                    PWSTR FileToFind,
 323                    PULONG pDirIndex,
 324                    PULONG pDirIndex2);
 325
 326 VOID vfat8Dot3ToString (PFAT_DIR_ENTRY pEntry,
 327                         PWSTR pName);
 328
 329 NTSTATUS ReadVolumeLabel(PDEVICE_EXTENSION DeviceExt,
 330                          PVPB Vpb);
 331
 332 BOOLEAN IsDeletedEntry (PVOID Block,
 333                         ULONG Offset);
 334
 335 BOOLEAN IsLastEntry (PVOID Block,
 336                      ULONG Offset);
 337
 338 /*  ---------------------------------------------------------  close.c  */
 339
 340 NTSTATUS VfatClose (PVFAT_IRP_CONTEXT IrpContext);
 341
 342 NTSTATUS VfatCloseFile(PDEVICE_EXTENSION DeviceExt,
 343                        PFILE_OBJECT FileObject);
 344
 345 /*  -------------------------------------------------------  cleanup.c  */
 346
 347 NTSTATUS VfatCleanup (PVFAT_IRP_CONTEXT IrpContext);
 348
 349 /*  ---------------------------------------------------------  fsctl.c  */
 350
 351 NTSTATUS VfatFileSystemControl (PVFAT_IRP_CONTEXT IrpContext);
 352
 353 /*  ---------------------------------------------------------  finfo.c  */
 354
 355 NTSTATUS VfatQueryInformation (PVFAT_IRP_CONTEXT IrpContext);
 356
 357 NTSTATUS VfatSetInformation (PVFAT_IRP_CONTEXT IrpContext);
 358
 359 NTSTATUS
 360 VfatSetAllocationSizeInformation(PFILE_OBJECT FileObject,
 361                                  PVFATFCB Fcb,
 362                                  PDEVICE_EXTENSION DeviceExt,
 363                                  PLARGE_INTEGER AllocationSize);
 364
 365 /*  ---------------------------------------------------------  iface.c  */
 366
 367 NTSTATUS STDCALL DriverEntry (PDRIVER_OBJECT DriverObject,
 368                               PUNICODE_STRING RegistryPath);
 369
 370 /*  ---------------------------------------------------------  dirwr.c  */
 371
 372 NTSTATUS VfatAddEntry (PDEVICE_EXTENSION DeviceExt,
 373                        PFILE_OBJECT pFileObject,
 374                        ULONG RequestedOptions,UCHAR ReqAttr);
 375
 376 NTSTATUS VfatUpdateEntry (PDEVICE_EXTENSION DeviceExt,
 377                           PFILE_OBJECT pFileObject);
 378
 379 NTSTATUS delEntry(PDEVICE_EXTENSION,
 380                   PFILE_OBJECT);
 381
 382 /*  --------------------------------------------------------  string.c  */
 383
 384 BOOLEAN wstrcmpjoki (PWSTR s1,
 385                      PWSTR s2);
 386
 387 PWCHAR vfatGetNextPathElement (PWCHAR  pFileName);
 388
 389 VOID vfatWSubString (PWCHAR pTarget,
 390                      const PWCHAR pSource,
 391                      size_t pLength);
 392
 393 BOOL  vfatIsFileNameValid (PWCHAR pFileName);
 394
 395 /*  -----------------------------------------------------------  fat.c  */
 396
 397 NTSTATUS OffsetToCluster (PDEVICE_EXTENSION DeviceExt,
 398                           PVFATFCB Fcb,
 399                           ULONG FirstCluster,
 400                           ULONG FileOffset,
 401                           PULONG Cluster,
 402                           BOOLEAN Extend);
 403
 404 ULONGLONG ClusterToSector (PDEVICE_EXTENSION DeviceExt,
 405                            ULONG Cluster);
 406
 407 NTSTATUS GetNextCluster (PDEVICE_EXTENSION DeviceExt,
 408                          ULONG CurrentCluster,
 409                          PULONG NextCluster,
 410                          BOOLEAN Extend);
 411
 412 NTSTATUS CountAvailableClusters (PDEVICE_EXTENSION DeviceExt,
 413                                  PLARGE_INTEGER Clusters);
 414
 415 /*  ------------------------------------------------------  direntry.c  */
 416
 417 ULONG  vfatDirEntryGetFirstCluster (PDEVICE_EXTENSION  pDeviceExt,
 418                                     PFAT_DIR_ENTRY  pDirEntry);
 419
 420 BOOL  vfatIsDirEntryDeleted (FATDirEntry * pFatDirEntry);
 421
 422 BOOL  vfatIsDirEntryVolume (FATDirEntry * pFatDirEntry);
 423
 424 BOOL  vfatIsDirEntryEndMarker (FATDirEntry * pFatDirEntry);
 425
 426 VOID vfatGetDirEntryName (PFAT_DIR_ENTRY pDirEntry,
 427                           PWSTR  pEntryName);
 428
 429 NTSTATUS vfatGetNextDirEntry(PVOID * pContext,
 430                              PVOID * pPage,
 431                              IN PVFATFCB pDirFcb,
 432                              IN OUT PULONG pDirIndex,
 433                              OUT PWSTR pFileName,
 434                              OUT PFAT_DIR_ENTRY pDirEntry,
 435                              OUT PULONG pStartIndex);
 436
 437 /*  -----------------------------------------------------------  fcb.c  */
 438
 439 PVFATFCB vfatNewFCB (PWCHAR pFileName);
 440
 441 VOID vfatDestroyFCB (PVFATFCB  pFCB);
 442
 443 VOID vfatGrabFCB (PDEVICE_EXTENSION  pVCB,
 444                   PVFATFCB  pFCB);
 445
 446 VOID vfatReleaseFCB (PDEVICE_EXTENSION  pVCB,
 447                      PVFATFCB  pFCB);
 448
 449 VOID vfatAddFCBToTable (PDEVICE_EXTENSION  pVCB,
 450                         PVFATFCB  pFCB);
 451
 452 PVFATFCB vfatGrabFCBFromTable (PDEVICE_EXTENSION  pDeviceExt,
 453                                PWSTR  pFileName);
 454
 455 PVFATFCB vfatMakeRootFCB (PDEVICE_EXTENSION  pVCB);
 456
 457 PVFATFCB vfatOpenRootFCB (PDEVICE_EXTENSION  pVCB);
 458
 459 BOOL vfatFCBIsDirectory (PVFATFCB FCB);
 460
 461 NTSTATUS vfatAttachFCBToFileObject (PDEVICE_EXTENSION  vcb,
 462                                     PVFATFCB  fcb,
 463                                     PFILE_OBJECT  fileObject);
 464
 465 NTSTATUS vfatDirFindFile (PDEVICE_EXTENSION  pVCB,
 466                           PVFATFCB  parentFCB,
 467                           PWSTR  elementName,
 468                           PVFATFCB * fileFCB);
 469
 470 NTSTATUS vfatGetFCBForFile (PDEVICE_EXTENSION  pVCB,
 471                             PVFATFCB  *pParentFCB,
 472                             PVFATFCB  *pFCB,
 473                             const PWSTR  pFileName);
 474
 475 NTSTATUS vfatMakeFCBFromDirEntry (PVCB  vcb,
 476                                   PVFATFCB  directoryFCB,
 477                                   PWSTR  longName,
 478                                   PFAT_DIR_ENTRY  dirEntry,
 479                                   ULONG startIndex,
 480                                   ULONG dirIndex,
 481                                   PVFATFCB * fileFCB);
 482
 483 /*  ------------------------------------------------------------  rw.c  */
 484
 485 NTSTATUS VfatRead (PVFAT_IRP_CONTEXT IrpContext);
 486
 487 NTSTATUS VfatWrite (PVFAT_IRP_CONTEXT IrpContext);
 488
 489 NTSTATUS NextCluster(PDEVICE_EXTENSION DeviceExt,
 490                      PVFATFCB Fcb,
 491                      ULONG FirstCluster,
 492                      PULONG CurrentCluster,
 493                      BOOLEAN Extend);
 494
 495 /*  -----------------------------------------------------------  misc.c  */
 496
 497 NTSTATUS VfatQueueRequest(PVFAT_IRP_CONTEXT IrpContext);
 498
 499 PVFAT_IRP_CONTEXT VfatAllocateIrpContext(PDEVICE_OBJECT DeviceObject,
 500                                          PIRP Irp);
 501
 502 VOID VfatFreeIrpContext(PVFAT_IRP_CONTEXT IrpContext);
 503
 504 NTSTATUS STDCALL VfatBuildRequest (PDEVICE_OBJECT DeviceObject,
 505                                    PIRP Irp);
 506
 507 PVOID VfatGetUserBuffer(IN PIRP);
 508
 509 NTSTATUS VfatLockUserBuffer(IN PIRP, IN ULONG,
 510                             IN LOCK_OPERATION);
 511
 512 NTSTATUS
 513 VfatSetExtendedAttributes(PFILE_OBJECT FileObject,
 514                           PVOID Ea,
 515                           ULONG EaLength);
 516 /*  ------------------------------------------------------------- flush.c  */
 517
 518 NTSTATUS VfatFlush(PVFAT_IRP_CONTEXT IrpContext);
 519
 520 NTSTATUS VfatFlushVolume(PDEVICE_EXTENSION DeviceExt, PVFATFCB VolumeFcb);
 521
 522 /* EOF */