[fastfat_new]
[reactos.git] / reactos / drivers / filesystems / fastfat_new / fastfat.h
index 44984e6..e138bd2 100644 (file)
 #include <ntifs.h>
 #include <ntdddisk.h>
-#include <reactos/helper.h>
 #include <debug.h>
+#include <pseh/pseh2.h>
+
+#include "fullfat.h"
 
-/* FAT on-disk data structures */
 #include <fat.h>
+#include <fatstruc.h>
+
+#define Add2Ptr(P,I,T) ((T)((PUCHAR)(P) + (I)))
+#define PtrOffset(B,O) ((ULONG)((ULONG_PTR)(O) - (ULONG_PTR)(B)))
+
+#define TAG_CCB  'BCCV'
+#define TAG_FCB  'BCFV'
+#define TAG_IRP  'PRIV'
+#define TAG_VFAT 'TAFV'
 
-/* File system types */
-#define FAT16  (1)
-#define FAT12  (2)
-#define FAT32  (3)
-#define FATX16 (4)
-#define FATX32 (5)
-
-/* VCB Flags */
-#define VCB_VOLUME_LOCKED       0x0001
-#define VCB_DISMOUNT_PENDING    0x0002
-#define VCB_IS_FATX             0x0004
-#define VCB_IS_DIRTY            0x4000 /* Volume is dirty */
-#define VCB_CLEAR_DIRTY         0x8000 /* Clean dirty flag at shutdown */
-
-typedef struct
-{
-  ULONG VolumeID;
-  ULONG FATStart;
-  ULONG FATCount;
-  ULONG FATSectors;
-  ULONG rootDirectorySectors;
-  ULONG rootStart;
-  ULONG dataStart;
-  ULONG RootCluster;
-  ULONG SectorsPerCluster;
-  ULONG BytesPerSector;
-  ULONG BytesPerCluster;
-  ULONG NumberOfClusters;
-  ULONG FatType;
-  ULONG Sectors;
-  BOOLEAN FixedMedia;
-} FATINFO, *PFATINFO;
-
-struct _VFATFCB;
-struct _VFAT_DIRENTRY_CONTEXT;
-
-typedef struct DEVICE_EXTENSION *PDEVICE_EXTENSION;
-
-typedef struct _DEVICE_EXTENSION
-{
-  ERESOURCE DirResource;
-  ERESOURCE FatResource;
-
-  KSPIN_LOCK FcbListLock;
-  LIST_ENTRY FcbListHead;
-  ULONG HashTableSize;
-  struct _HASHENTRY** FcbHashTable;
-
-  PDEVICE_OBJECT StorageDevice;
-  PFILE_OBJECT FATFileObject;
-  FATINFO FatInfo;
-  ULONG LastAvailableCluster;
-  ULONG AvailableClusters;
-  BOOLEAN AvailableClustersValid;
-  ULONG Flags;
-  struct _VFATFCB * VolumeFcb;
-
-  ULONG BaseDateYear;
-
-  LIST_ENTRY VolumeListEntry;
-} DEVICE_EXTENSION;
-
-typedef struct _FAT_GLOBAL_DATA
-{
-    ERESOURCE Resource;
-    PDRIVER_OBJECT DriverObject;
-    PDEVICE_OBJECT DiskDeviceObject;
-    NPAGED_LOOKASIDE_LIST NonPagedFcbList;
-    NPAGED_LOOKASIDE_LIST ResourceList;
-    NPAGED_LOOKASIDE_LIST IrpContextList;
-    FAST_IO_DISPATCH FastIoDispatch;
-    CACHE_MANAGER_CALLBACKS CacheMgrCallbacks;
-    CACHE_MANAGER_CALLBACKS CacheMgrNoopCallbacks;
-} FAT_GLOBAL_DATA, *VFAT_GLOBAL_DATA;
-
-extern FAT_GLOBAL_DATA FatGlobalData;
-
-/* FCB flags */
-#define FCB_CACHE_INITIALIZED   0x0001
-#define FCB_DELETE_PENDING      0x0002
-#define FCB_IS_FAT              0x0004
-#define FCB_IS_PAGE_FILE        0x0008
-#define FCB_IS_VOLUME           0x0010
-#define FCB_IS_DIRTY            0x0020
-#define FCB_IS_FATX_ENTRY       0x0040
-
-typedef struct _VFATFCB
-{
-  /* FCB header required by ROS/NT */
-  FSRTL_COMMON_FCB_HEADER RFCB;
-  SECTION_OBJECT_POINTERS SectionObjectPointers;
-  ERESOURCE MainResource;
-  ERESOURCE PagingIoResource;
-  /* end FCB header required by ROS/NT */
-
-  /* Pointer to attributes in entry */
-  PUCHAR Attributes;
-
-  /* long file name, points into PathNameBuffer */
-  UNICODE_STRING LongNameU;
-
-  /* short file name */
-  UNICODE_STRING ShortNameU;
-
-  /* directory name, points into PathNameBuffer */
-  UNICODE_STRING DirNameU;
-
-  /* path + long file name 260 max*/
-  UNICODE_STRING PathNameU;
-
-  /* buffer for PathNameU */
-  PWCHAR PathNameBuffer;
-
-  /* buffer for ShortNameU */
-  WCHAR ShortNameBuffer[13];
-
-  /* */
-  LONG RefCount;
-
-  /* List of FCB's for this volume */
-  LIST_ENTRY FcbListEntry;
-
-  /* pointer to the parent fcb */
-  struct _VFATFCB* parentFcb;
-
-  /* Flags for the fcb */
-  ULONG Flags;
-
-  /* pointer to the file object which has initialized the fcb */
-  PFILE_OBJECT FileObject;
-
-  /* Directory index for the short name entry */
-  ULONG dirIndex;
-
-  /* Directory index where the long name starts */
-  ULONG startIndex;
-
-  /* Share access for the file object */
-  SHARE_ACCESS FCBShareAccess;
-
-  /* Incremented on IRP_MJ_CREATE, decremented on IRP_MJ_CLEANUP */
-  ULONG OpenHandleCount;
-
-  /* List of byte-range locks for this file */
-  FILE_LOCK FileLock;
-
-  /*
-   * Optimalization: caching of last read/write cluster+offset pair. Can't
-   * be in VFATCCB because it must be reset everytime the allocated clusters
-   * change.
-   */
-  FAST_MUTEX LastMutex;
-  ULONG LastCluster;
-  ULONG LastOffset;
-} VFATFCB, *PVFATFCB;
-
-typedef struct _VFATCCB
-{
-  LARGE_INTEGER  CurrentByteOffset;
-  /* for DirectoryControl */
-  ULONG Entry;
-  /* for DirectoryControl */
-  UNICODE_STRING SearchPattern;
-} VFATCCB, *PVFATCCB;
-
-/* Volume Control Block */
-typedef struct _VCB
-{
-    FSRTL_ADVANCED_FCB_HEADER VolumeFileHeader;
-} VCB, *PVCB;
-
-/* Volume Device Object */
-typedef struct _VOLUME_DEVICE_OBJECT
-{
-    DEVICE_OBJECT DeviceObject;
-    FSRTL_COMMON_FCB_HEADER VolumeHeader;
-    VCB Vcb; /* Must be the last entry! */
-} VOLUME_DEVICE_OBJECT, *PVOLUME_DEVICE_OBJECT;
-
-
-#ifndef TAG
-#define TAG(A, B, C, D) (ULONG)(((A)<<0) + ((B)<<8) + ((C)<<16) + ((D)<<24))
-#endif
-
-#define TAG_CCB TAG('V', 'C', 'C', 'B')
-#define TAG_FCB TAG('V', 'F', 'C', 'B')
-#define TAG_IRP TAG('V', 'I', 'R', 'P')
-#define TAG_VFAT TAG('V', 'F', 'A', 'T')
-
-typedef struct __DOSTIME
-{
-   USHORT Second:5;
-   USHORT Minute:6;
-   USHORT Hour:5;
-}
-DOSTIME, *PDOSTIME;
 
-typedef struct __DOSDATE
-{
-   USHORT Day:5;
-   USHORT Month:4;
-   USHORT Year:5;
+/* Global resource acquire/release */
+#define FatAcquireExclusiveGlobal(IrpContext) \
+( \
+    ExAcquireResourceExclusiveLite(&FatGlobalData.Resource, \
+                                   (IrpContext)->Flags & IRPCONTEXT_CANWAIT) \
+)
+
+#define FatAcquireSharedGlobal(IrpContext) \
+( \
+    ExAcquireResourceSharedLite(&FatGlobalData.Resource, \
+                                (IrpContext)->Flags & IRPCONTEXT_CANWAIT) \
+)
+
+#define FatReleaseGlobal(IrpContext) \
+{ \
+    ExReleaseResourceLite(&(FatGlobalData.Resource)); \
 }
-DOSDATE, *PDOSDATE;
-
-#define IRPCONTEXT_CANWAIT          0x0001
-#define IRPCONTEXT_PENDINGRETURNED  0x0002
-#define IRPCONTEXT_STACK_IO_CONTEXT 0x0004
-
-typedef struct _FAT_IRP_CONTEXT
-{
-   PIRP Irp;
-   PDEVICE_OBJECT DeviceObject;
-   UCHAR MajorFunction;
-   UCHAR MinorFunction;
-   PFILE_OBJECT FileObject;
-   ULONG Flags;
-   PVCB Vcb;
-   ULONG PinCount;
-   struct _FAT_IO_CONTEXT *FatIoContext;
-
-   PDEVICE_EXTENSION DeviceExt;
-   WORK_QUEUE_ITEM WorkQueueItem;
-   PIO_STACK_LOCATION Stack;
-   KEVENT Event;
-} FAT_IRP_CONTEXT, *PFAT_IRP_CONTEXT;
-
-typedef struct _FAT_IO_CONTEXT
-{
-    PMDL ZeroMdl;
-} _FAT_IO_CONTEXT, *PFAT_IO_CONTEXT;
+
 
 /*  ------------------------------------------------------  shutdown.c  */
 
@@ -253,17 +51,40 @@ NTSTATUS NTAPI
 FatSetVolumeInfo(PDEVICE_OBJECT DeviceObject, PIRP Irp);
 
 /*  ------------------------------------------------------  blockdev.c  */
+NTSTATUS
+NTAPI
+FatPerformLboIo(
+    IN PFAT_IRP_CONTEXT IrpContext,
+    IN PLARGE_INTEGER Offset,
+    IN SIZE_T Length);
+
+NTSTATUS
+FatPerformVirtualNonCachedIo(
+    IN PFAT_IRP_CONTEXT IrpContext,
+    IN PFCB Fcb,
+    IN PLARGE_INTEGER Offset,
+    IN SIZE_T Length);
 
 /*  -----------------------------------------------------------  dir.c  */
 
 NTSTATUS NTAPI
 FatDirectoryControl(PDEVICE_OBJECT DeviceObject, PIRP Irp);
 
+VOID NTAPI
+FatCreateRootDcb(IN PFAT_IRP_CONTEXT IrpContext,
+                 IN PVCB Vcb);
+
+PFCB NTAPI
+FatCreateDcb(IN PFAT_IRP_CONTEXT IrpContext,
+             IN PVCB Vcb,
+             IN PFCB ParentDcb);
+
 /*  --------------------------------------------------------  create.c  */
 
 NTSTATUS NTAPI
 FatCreate(PDEVICE_OBJECT DeviceObject, PIRP Irp);
 
+
 /*  ---------------------------------------------------------  close.c  */
 
 NTSTATUS NTAPI
@@ -308,11 +129,59 @@ FatBuildIrpContext(PIRP Irp, BOOLEAN CanWait);
 VOID NTAPI
 FatDestroyIrpContext(PFAT_IRP_CONTEXT IrpContext);
 
+VOID
+NTAPI
+FatQueueRequest(IN PFAT_IRP_CONTEXT IrpContext,
+                IN PFAT_OPERATION_HANDLER OperationHandler);
+
 VOID NTAPI
 FatCompleteRequest(PFAT_IRP_CONTEXT IrpContext OPTIONAL,
                    PIRP Irp OPTIONAL,
                    NTSTATUS Status);
 
+BOOLEAN NTAPI
+FatAcquireExclusiveVcb(IN PFAT_IRP_CONTEXT IrpContext,
+                       IN PVCB Vcb);
+
+VOID NTAPI
+FatReleaseVcb(IN PFAT_IRP_CONTEXT IrpContext,
+              IN PVCB Vcb);
+
+BOOLEAN NTAPI
+FatAcquireExclusiveFcb(IN PFAT_IRP_CONTEXT IrpContext,
+                       IN PFCB Fcb);
+
+BOOLEAN NTAPI
+FatAcquireSharedFcb(IN PFAT_IRP_CONTEXT IrpContext,
+                       IN PFCB Fcb);
+
+VOID NTAPI
+FatReleaseFcb(IN PFAT_IRP_CONTEXT IrpContext,
+              IN PFCB Fcb);
+
+TYPE_OF_OPEN
+NTAPI
+FatDecodeFileObject(IN PFILE_OBJECT FileObject,
+                    OUT PVCB *Vcb,
+                    OUT PFCB *FcbOrDcb,
+                    OUT PCCB *Ccb);
+
+VOID NTAPI
+FatSetFileObject(PFILE_OBJECT FileObject,
+                 TYPE_OF_OPEN TypeOfOpen,
+                 PVOID Fcb,
+                 PCCB Ccb);
+
+PVOID FASTCALL
+FatMapUserBuffer(PIRP Irp);
+
+/* --------------------------------------------------------- fullfat.c */
+
+FF_T_SINT32
+FatWriteBlocks(FF_T_UINT8 *pBuffer, FF_T_UINT32 SectorAddress, FF_T_UINT32 Count, void *pParam);
+
+FF_T_SINT32
+FatReadBlocks(FF_T_UINT8 *pBuffer, FF_T_UINT32 SectorAddress, FF_T_UINT32 Count, void *pParam);
 
 /* ---------------------------------------------------------  lock.c */
 
@@ -336,15 +205,113 @@ NTAPI
 DriverEntry(PDRIVER_OBJECT DriverObject, PUNICODE_STRING RegistryPath);
 
 /*  -----------------------------------------------------------  fat.c  */
+PVOID
+FatPinPage(
+    PFAT_PAGE_CONTEXT Context,
+    LONGLONG ByteOffset);
+
+PVOID
+FatPinNextPage(
+    PFAT_PAGE_CONTEXT Context);
+
+NTSTATUS
+FatInitializeVcb(
+    IN PFAT_IRP_CONTEXT IrpContext,
+    IN PVCB Vcb,
+    IN PDEVICE_OBJECT TargetDeviceObject,
+    IN PVPB Vpb);
+
+VOID
+FatUninitializeVcb(
+    IN PVCB Vcb);
+
+ULONG
+FatScanFat(
+    IN PFCB Fcb,
+    IN LONGLONG Vbo, OUT PLONGLONG Lbo,
+    IN OUT PLONGLONG Length,
+    OUT PULONG Index,
+    IN BOOLEAN CanWait);
 
 /*  ------------------------------------------------------  device.c  */
 
 NTSTATUS NTAPI
 FatDeviceControl(PDEVICE_OBJECT DeviceObject, PIRP Irp);
 
+NTSTATUS
+FatPerformDevIoCtrl(PDEVICE_OBJECT DeviceObject,
+                    ULONG ControlCode,
+                    PVOID InputBuffer,
+                    ULONG InputBufferSize,
+                    PVOID OutputBuffer,
+                    ULONG OutputBufferSize,
+                    BOOLEAN Override);
+
 /*  ------------------------------------------------------  direntry.c  */
+VOID
+FatFindDirent(IN OUT PFAT_FIND_DIRENT_CONTEXT Context,
+              OUT PDIR_ENTRY* Dirent,
+              OUT PUNICODE_STRING LongFileName OPTIONAL);
+
+VOID
+FatEnumerateDirents(IN OUT PFAT_ENUM_DIRENT_CONTEXT Context,
+                    IN SIZE_T Offset);
+
+VOID
+FatQueryFileTimes(OUT PLARGE_INTEGER FileTimes,
+                  IN PDIR_ENTRY Dirent);
 
 /*  -----------------------------------------------------------  fcb.c  */
+PFCB
+FatLookupFcbByName(
+       IN PFCB ParentFcb,
+       IN PUNICODE_STRING Name);
+
+BOOLEAN
+FatLinkFcbNames(
+       IN PFCB ParentFcb,
+       IN PFCB Fcb);
+
+VOID
+FatUnlinkFcbNames(
+       IN PFCB ParentFcb,
+       IN PFCB Fcb);
+
+PFCB NTAPI
+FatCreateFcb(
+    IN PFAT_IRP_CONTEXT IrpContext,
+    IN PVCB Vcb,
+    IN PFCB ParentDcb,
+    IN FF_FILE *FileHandle);
+
+NTSTATUS
+FatOpenFcb(
+    OUT PFCB* Fcb,
+    IN PFAT_IRP_CONTEXT IrpContext,
+    IN PFCB ParentFcb,
+    IN PUNICODE_STRING FileName);
+
+PFCB NTAPI
+FatFindFcb(PFAT_IRP_CONTEXT IrpContext,
+           PRTL_SPLAY_LINKS *RootNode,
+           PSTRING AnsiName,
+           PBOOLEAN IsDosName);
+
+PCCB NTAPI
+FatCreateCcb();
+
+VOID NTAPI
+FatSetFullNameInFcb(PFCB Fcb,
+                    PUNICODE_STRING Name);
+
+VOID NTAPI
+FatSetFcbNames(IN PFAT_IRP_CONTEXT IrpContext,
+               IN PFCB Fcb);
+
+VOID NTAPI
+Fati8dot3ToString(IN PCHAR FileName,
+                  IN BOOLEAN DownCase,
+                  OUT POEM_STRING OutString);
 
 /*  ------------------------------------------------------------  rw.c  */