1 /* $Id: vfat.h,v 1.61 2003/11/12 15:26:44 ekohl Exp $ */
5 #define ROUND_UP(N, S) ((((N) + (S) - 1) / (S)) * (S))
6 #define ROUND_DOWN(N, S) ((N) - ((N) % (S)))
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
;
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
));
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
));
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
));
66 typedef struct _BootSector BootSector
;
68 #define VFAT_CASE_LOWER_BASE 8 // base is lower case
69 #define VFAT_CASE_LOWER_EXT 16 // extension is lower case
71 #define ENTRY_DELETED(DirEntry) ((DirEntry)->Filename[0] == 0xe5)
72 #define ENTRY_END(DirEntry) ((DirEntry)->Filename[0] == 0)
73 #define ENTRY_LONG(DirEntry) (((DirEntry)->Attrib & 0x3f) == 0x0f)
74 #define ENTRY_VOLUME(DirEntry) (((DirEntry)->Attrib & 0x1f) == 0x08)
78 unsigned char Filename
[8], Ext
[3];
81 unsigned char CreationTimeMs
;
82 unsigned short CreationTime
,CreationDate
,AccessDate
;
83 unsigned short FirstClusterHigh
; // higher
84 unsigned short UpdateTime
; //time create/update
85 unsigned short UpdateDate
; //date create/update
86 unsigned short FirstCluster
;
87 unsigned long FileSize
;
88 } __attribute__((packed
));
90 typedef struct _FATDirEntry FATDirEntry
, FAT_DIR_ENTRY
, *PFAT_DIR_ENTRY
;
94 unsigned char id
; // sequence number for slot
95 WCHAR name0_4
[5]; // first 5 characters in name
96 unsigned char attr
; // attribute byte
97 unsigned char reserved
; // always 0
98 unsigned char alias_checksum
; // checksum for 8.3 alias
99 WCHAR name5_10
[6]; // 6 more characters in name
100 unsigned char start
[2]; // starting cluster number
101 WCHAR name11_12
[2]; // last 2 characters in name
102 } __attribute__((packed
));
105 typedef struct _slot slot
;
107 #define BLOCKSIZE 512
113 #define VCB_VOLUME_LOCKED 0x0001
114 #define VCB_DISMOUNT_PENDING 0x0002
122 ULONG rootDirectorySectors
;
126 ULONG SectorsPerCluster
;
127 ULONG BytesPerSector
;
128 ULONG BytesPerCluster
;
129 ULONG NumberOfClusters
;
132 } FATINFO
, *PFATINFO
;
136 typedef struct _HASHENTRY
139 struct _VFATFCB
* self
;
140 struct _HASHENTRY
* next
;
144 #define FCB_HASH_TABLE_SIZE 1024
148 ERESOURCE DirResource
;
149 ERESOURCE FatResource
;
151 KSPIN_LOCK FcbListLock
;
152 LIST_ENTRY FcbListHead
;
153 struct _HASHENTRY
* FcbHashTable
[FCB_HASH_TABLE_SIZE
];
155 PDEVICE_OBJECT StorageDevice
;
156 PFILE_OBJECT FATFileObject
;
158 ULONG LastAvailableCluster
;
159 ULONG AvailableClusters
;
160 BOOLEAN AvailableClustersValid
;
162 struct _VFATFCB
* VolumeFcb
;
164 LIST_ENTRY VolumeListEntry
;
165 } DEVICE_EXTENSION
, *PDEVICE_EXTENSION
, VCB
, *PVCB
;
169 PDRIVER_OBJECT DriverObject
;
170 PDEVICE_OBJECT DeviceObject
;
172 ERESOURCE VolumeListLock
;
173 LIST_ENTRY VolumeListHead
;
174 NPAGED_LOOKASIDE_LIST FcbLookasideList
;
175 NPAGED_LOOKASIDE_LIST CcbLookasideList
;
176 NPAGED_LOOKASIDE_LIST IrpContextLookasideList
;
177 } VFAT_GLOBAL_DATA
, *PVFAT_GLOBAL_DATA
;
179 extern PVFAT_GLOBAL_DATA VfatGlobalData
;
181 #define FCB_CACHE_INITIALIZED 0x0001
182 #define FCB_DELETE_PENDING 0x0002
183 #define FCB_IS_FAT 0x0004
184 #define FCB_IS_PAGE_FILE 0x0008
185 #define FCB_IS_VOLUME 0x0010
186 #define FCB_IS_DIRTY 0x0020
188 typedef struct _VFATFCB
190 /* FCB header required by ROS/NT */
191 FSRTL_COMMON_FCB_HEADER RFCB
;
192 SECTION_OBJECT_POINTERS SectionObjectPointers
;
193 ERESOURCE MainResource
;
194 ERESOURCE PagingIoResource
;
195 /* end FCB header required by ROS/NT */
197 /* directory entry for this file or directory */
200 /* long file name, points into PathNameBuffer */
201 UNICODE_STRING LongNameU
;
203 /* short file name */
204 UNICODE_STRING ShortNameU
;
206 /* directory name, points into PathNameBuffer */
207 UNICODE_STRING DirNameU
;
209 /* path + long file name 260 max*/
210 UNICODE_STRING PathNameU
;
212 /* buffer for PathNameU */
213 WCHAR PathNameBuffer
[MAX_PATH
];
215 /* buffer for ShortNameU */
216 WCHAR ShortNameBuffer
[13];
221 /* List of FCB's for this volume */
222 LIST_ENTRY FcbListEntry
;
224 /* pointer to the parent fcb */
225 struct _VFATFCB
* parentFcb
;
227 /* Flags for the fcb */
230 /* pointer to the file object which has initialized the fcb */
231 PFILE_OBJECT FileObject
;
233 /* Directory index for the short name entry */
236 /* Directory index where the long name starts */
239 /* Share access for the file object */
240 SHARE_ACCESS FCBShareAccess
;
242 /* Entry into the hash table for the path + long name */
245 /* Entry into the hash table for the path + short name */
248 /* List of byte-range locks for this file */
251 } VFATFCB
, *PVFATFCB
;
253 typedef struct _VFATCCB
255 LARGE_INTEGER CurrentByteOffset
;
256 /* for DirectoryControl */
258 /* for DirectoryControl */
259 UNICODE_STRING SearchPattern
;
263 } VFATCCB
, *PVFATCCB
;
266 #define TAG(A, B, C, D) (ULONG)(((A)<<0) + ((B)<<8) + ((C)<<16) + ((D)<<24))
269 #define TAG_CCB TAG('V', 'C', 'C', 'B')
270 #define TAG_FCB TAG('V', 'F', 'C', 'B')
271 #define TAG_IRP TAG('V', 'I', 'R', 'P')
273 #define ENTRIES_PER_SECTOR (BLOCKSIZE / sizeof(FATDirEntry))
275 typedef struct __DOSTIME
283 typedef struct __DOSDATE
291 #define IRPCONTEXT_CANWAIT 0x0001
296 PDEVICE_OBJECT DeviceObject
;
297 PDEVICE_EXTENSION DeviceExt
;
299 WORK_QUEUE_ITEM WorkQueueItem
;
300 PIO_STACK_LOCATION Stack
;
303 PFILE_OBJECT FileObject
;
304 } VFAT_IRP_CONTEXT
, *PVFAT_IRP_CONTEXT
;
306 typedef struct _VFAT_DIRENTRY_CONTEXT
310 FAT_DIR_ENTRY FatDirEntry
;
311 UNICODE_STRING LongNameU
;
312 UNICODE_STRING ShortNameU
;
313 } VFAT_DIRENTRY_CONTEXT
, *PVFAT_DIRENTRY_CONTEXT
;
316 /* ------------------------------------------------------ shutdown.c */
318 NTSTATUS STDCALL
VfatShutdown (PDEVICE_OBJECT DeviceObject
,
321 /* -------------------------------------------------------- volume.c */
323 NTSTATUS
VfatQueryVolumeInformation (PVFAT_IRP_CONTEXT IrpContext
);
325 NTSTATUS
VfatSetVolumeInformation (PVFAT_IRP_CONTEXT IrpContext
);
327 /* ------------------------------------------------------ blockdev.c */
329 NTSTATUS
VfatReadDisk(IN PDEVICE_OBJECT pDeviceObject
,
330 IN PLARGE_INTEGER ReadOffset
,
333 IN BOOLEAN Override
);
335 NTSTATUS
VfatWriteDisk(IN PDEVICE_OBJECT pDeviceObject
,
336 IN PLARGE_INTEGER WriteOffset
,
337 IN ULONG WriteLength
,
340 NTSTATUS
VfatBlockDeviceIoControl (IN PDEVICE_OBJECT DeviceObject
,
342 IN PVOID InputBuffer
,
343 IN ULONG InputBufferSize
,
344 IN OUT PVOID OutputBuffer
,
345 IN OUT PULONG pOutputBufferSize
,
346 IN BOOLEAN Override
);
348 /* ----------------------------------------------------------- dir.c */
350 NTSTATUS
VfatDirectoryControl (PVFAT_IRP_CONTEXT
);
352 BOOL
FsdDosDateTimeToFileTime (WORD wDosDate
,
356 BOOL
FsdFileTimeToDosDateTime (TIME
*FileTime
,
360 /* -------------------------------------------------------- create.c */
362 NTSTATUS
VfatCreate (PVFAT_IRP_CONTEXT IrpContext
);
364 NTSTATUS
VfatOpenFile (PDEVICE_EXTENSION DeviceExt
,
365 PFILE_OBJECT FileObject
,
366 PUNICODE_STRING FileNameU
);
368 NTSTATUS
FindFile (PDEVICE_EXTENSION DeviceExt
,
370 PUNICODE_STRING FileToFindU
,
371 PVFAT_DIRENTRY_CONTEXT DirContext
,
374 VOID
vfat8Dot3ToString (PFAT_DIR_ENTRY pEntry
,
375 PUNICODE_STRING NameU
);
377 NTSTATUS
ReadVolumeLabel(PDEVICE_EXTENSION DeviceExt
,
380 /* --------------------------------------------------------- close.c */
382 NTSTATUS
VfatClose (PVFAT_IRP_CONTEXT IrpContext
);
384 NTSTATUS
VfatCloseFile(PDEVICE_EXTENSION DeviceExt
,
385 PFILE_OBJECT FileObject
);
387 /* ------------------------------------------------------- cleanup.c */
389 NTSTATUS
VfatCleanup (PVFAT_IRP_CONTEXT IrpContext
);
391 /* --------------------------------------------------------- fsctl.c */
393 NTSTATUS
VfatFileSystemControl (PVFAT_IRP_CONTEXT IrpContext
);
395 /* --------------------------------------------------------- finfo.c */
397 NTSTATUS
VfatQueryInformation (PVFAT_IRP_CONTEXT IrpContext
);
399 NTSTATUS
VfatSetInformation (PVFAT_IRP_CONTEXT IrpContext
);
402 VfatSetAllocationSizeInformation(PFILE_OBJECT FileObject
,
404 PDEVICE_EXTENSION DeviceExt
,
405 PLARGE_INTEGER AllocationSize
);
407 /* --------------------------------------------------------- iface.c */
409 NTSTATUS STDCALL
DriverEntry (PDRIVER_OBJECT DriverObject
,
410 PUNICODE_STRING RegistryPath
);
412 /* --------------------------------------------------------- dirwr.c */
414 NTSTATUS
VfatAddEntry (PDEVICE_EXTENSION DeviceExt
,
415 PUNICODE_STRING PathNameU
,
416 PFILE_OBJECT pFileObject
,
417 ULONG RequestedOptions
,
420 NTSTATUS
VfatUpdateEntry (PVFATFCB pFcb
);
422 NTSTATUS
VfatDelEntry(PDEVICE_EXTENSION
, PVFATFCB
);
424 /* -------------------------------------------------------- string.c */
427 vfatSplitPathName(PUNICODE_STRING PathNameU
,
428 PUNICODE_STRING DirNameU
,
429 PUNICODE_STRING FileNameU
);
431 BOOLEAN
vfatIsLongIllegal(WCHAR c
);
433 BOOLEAN
wstrcmpjoki (PWSTR s1
,
436 /* ----------------------------------------------------------- fat.c */
438 NTSTATUS
OffsetToCluster (PDEVICE_EXTENSION DeviceExt
,
444 ULONGLONG
ClusterToSector (PDEVICE_EXTENSION DeviceExt
,
447 NTSTATUS
GetNextCluster (PDEVICE_EXTENSION DeviceExt
,
448 ULONG CurrentCluster
,
452 NTSTATUS
CountAvailableClusters (PDEVICE_EXTENSION DeviceExt
,
453 PLARGE_INTEGER Clusters
);
456 WriteCluster(PDEVICE_EXTENSION DeviceExt
,
457 ULONG ClusterToWrite
,
460 /* ------------------------------------------------------ direntry.c */
462 ULONG
vfatDirEntryGetFirstCluster (PDEVICE_EXTENSION pDeviceExt
,
463 PFAT_DIR_ENTRY pDirEntry
);
465 BOOL
VfatIsDirectoryEmpty(PVFATFCB Fcb
);
467 NTSTATUS
vfatGetNextDirEntry(PVOID
* pContext
,
470 IN PVFAT_DIRENTRY_CONTEXT DirContext
,
473 /* ----------------------------------------------------------- fcb.c */
475 PVFATFCB
vfatNewFCB (PUNICODE_STRING pFileNameU
);
477 VOID
vfatDestroyFCB (PVFATFCB pFCB
);
479 VOID
vfatDestroyCCB(PVFATCCB pCcb
);
481 VOID
vfatGrabFCB (PDEVICE_EXTENSION pVCB
,
484 VOID
vfatReleaseFCB (PDEVICE_EXTENSION pVCB
,
487 VOID
vfatAddFCBToTable (PDEVICE_EXTENSION pVCB
,
490 PVFATFCB
vfatGrabFCBFromTable (PDEVICE_EXTENSION pDeviceExt
,
491 PUNICODE_STRING pFileNameU
);
493 PVFATFCB
vfatMakeRootFCB (PDEVICE_EXTENSION pVCB
);
495 PVFATFCB
vfatOpenRootFCB (PDEVICE_EXTENSION pVCB
);
497 BOOL
vfatFCBIsDirectory (PVFATFCB FCB
);
499 BOOL
vfatFCBIsRoot(PVFATFCB FCB
);
501 NTSTATUS
vfatAttachFCBToFileObject (PDEVICE_EXTENSION vcb
,
503 PFILE_OBJECT fileObject
);
505 NTSTATUS
vfatDirFindFile (PDEVICE_EXTENSION pVCB
,
507 PUNICODE_STRING FileToFindU
,
510 NTSTATUS
vfatGetFCBForFile (PDEVICE_EXTENSION pVCB
,
511 PVFATFCB
*pParentFCB
,
513 PUNICODE_STRING pFileNameU
);
515 NTSTATUS
vfatMakeFCBFromDirEntry (PVCB vcb
,
516 PVFATFCB directoryFCB
,
517 PVFAT_DIRENTRY_CONTEXT DirContext
,
520 /* ------------------------------------------------------------ rw.c */
522 NTSTATUS
VfatRead (PVFAT_IRP_CONTEXT IrpContext
);
524 NTSTATUS
VfatWrite (PVFAT_IRP_CONTEXT IrpContext
);
526 NTSTATUS
NextCluster(PDEVICE_EXTENSION DeviceExt
,
528 PULONG CurrentCluster
,
531 /* ----------------------------------------------------------- misc.c */
533 NTSTATUS
VfatQueueRequest(PVFAT_IRP_CONTEXT IrpContext
);
535 PVFAT_IRP_CONTEXT
VfatAllocateIrpContext(PDEVICE_OBJECT DeviceObject
,
538 VOID
VfatFreeIrpContext(PVFAT_IRP_CONTEXT IrpContext
);
540 NTSTATUS STDCALL
VfatBuildRequest (PDEVICE_OBJECT DeviceObject
,
543 PVOID
VfatGetUserBuffer(IN PIRP
);
545 NTSTATUS
VfatLockUserBuffer(IN PIRP
, IN ULONG
,
549 VfatSetExtendedAttributes(PFILE_OBJECT FileObject
,
552 /* ------------------------------------------------------------- flush.c */
554 NTSTATUS
VfatFlush(PVFAT_IRP_CONTEXT IrpContext
);
556 NTSTATUS
VfatFlushVolume(PDEVICE_EXTENSION DeviceExt
, PVFATFCB VolumeFcb
);