3 * Copyright (C) 2002, 2004 ReactOS Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 * COPYRIGHT: See COPYING in the top level directory
21 * PROJECT: ReactOS kernel
22 * FILE: drivers/filesystems/cdfs/fcb.c
23 * PURPOSE: CDROM (ISO 9660) filesystem driver
24 * PROGRAMMER: Art Yerkes
28 /* INCLUDES *****************************************************************/
35 /* FUNCTIONS ****************************************************************/
37 #define ROUND_UP(N, S) ((((N) + (S) - 1) / (S)) * (S))
40 /* FUNCTIONS ****************************************************************/
43 CdfsGetNextPathElement(PCUNICODE_STRING CurrentElement
, PUNICODE_STRING NextElement
)
45 *NextElement
= *CurrentElement
;
47 if (NextElement
->Length
== 0)
50 while ((NextElement
->Length
) && (NextElement
->Buffer
[0] != L
'\\'))
52 NextElement
->Buffer
++;
53 NextElement
->Length
-= sizeof(WCHAR
);
54 NextElement
->MaximumLength
-= sizeof(WCHAR
);
62 CdfsCreateFCB(PCWSTR FileName
)
66 Fcb
= ExAllocatePoolWithTag(NonPagedPool
,
68 CDFS_NONPAGED_FCB_TAG
);
71 RtlZeroMemory(Fcb
, sizeof(FCB
));
72 RtlInitEmptyUnicodeString(&Fcb
->PathName
, Fcb
->PathNameBuffer
, sizeof(Fcb
->PathNameBuffer
));
76 RtlAppendUnicodeToString(&Fcb
->PathName
, FileName
);
77 if (wcsrchr(Fcb
->PathName
.Buffer
, '\\') != 0)
79 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
.Buffer
, '\\');
83 Fcb
->ObjectName
= Fcb
->PathName
.Buffer
;
87 ExInitializeResourceLite(&Fcb
->PagingIoResource
);
88 ExInitializeResourceLite(&Fcb
->MainResource
);
89 ExInitializeResourceLite(&Fcb
->NameListResource
);
90 Fcb
->RFCB
.PagingIoResource
= &Fcb
->PagingIoResource
;
91 Fcb
->RFCB
.Resource
= &Fcb
->MainResource
;
92 Fcb
->RFCB
.IsFastIoPossible
= FastIoIsNotPossible
;
93 InitializeListHead(&Fcb
->ShortNameList
);
94 FsRtlInitializeFileLock(&Fcb
->FileLock
, NULL
, NULL
);
101 CdfsDestroyFCB(PFCB Fcb
)
105 FsRtlUninitializeFileLock(&Fcb
->FileLock
);
106 ExDeleteResourceLite(&Fcb
->PagingIoResource
);
107 ExDeleteResourceLite(&Fcb
->MainResource
);
109 while (!IsListEmpty(&Fcb
->ShortNameList
))
111 Entry
= Fcb
->ShortNameList
.Flink
;
112 RemoveEntryList(Entry
);
113 ExFreePoolWithTag(Entry
, CDFS_SHORT_NAME_TAG
);
116 ExDeleteResourceLite(&Fcb
->NameListResource
);
117 ExFreePoolWithTag(Fcb
, CDFS_NONPAGED_FCB_TAG
);
122 CdfsFCBIsDirectory(PFCB Fcb
)
124 return(Fcb
->Entry
.FileFlags
& FILE_FLAG_DIRECTORY
);
129 CdfsFCBIsRoot(PFCB Fcb
)
131 return (Fcb
->PathName
.Length
== sizeof(WCHAR
) && Fcb
->PathName
.Buffer
[0] == L
'\\');
136 CdfsGrabFCB(PDEVICE_EXTENSION Vcb
,
141 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
146 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
148 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
153 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb
,
158 DPRINT("releasing FCB at %p: %wZ, refCount:%d\n",
163 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
165 if (Fcb
->RefCount
<= 0 && !CdfsFCBIsDirectory(Fcb
))
167 RemoveEntryList(&Fcb
->FcbListEntry
);
170 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
175 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb
,
180 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
182 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
183 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
188 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb
,
189 PUNICODE_STRING FileName
)
193 PLIST_ENTRY current_entry
;
195 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
197 if (FileName
== NULL
|| FileName
->Length
== 0 || FileName
->Buffer
[0] == 0)
199 DPRINT("Return FCB for stream file object\n");
200 Fcb
= Vcb
->StreamFileObject
->FsContext
;
202 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
206 current_entry
= Vcb
->FcbListHead
.Flink
;
207 while (current_entry
!= &Vcb
->FcbListHead
)
209 Fcb
= CONTAINING_RECORD(current_entry
, FCB
, FcbListEntry
);
211 DPRINT("Comparing '%wZ' and '%wZ'\n", FileName
, &Fcb
->PathName
);
212 if (RtlCompareUnicodeString(FileName
, &Fcb
->PathName
, TRUE
) == 0)
215 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
219 //FIXME: need to compare against short name in FCB here
221 current_entry
= current_entry
->Flink
;
223 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
230 CdfsFCBInitializeCache(PVCB Vcb
,
233 PFILE_OBJECT FileObject
;
236 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
238 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), CDFS_CCB_TAG
);
241 return STATUS_INSUFFICIENT_RESOURCES
;
243 RtlZeroMemory(newCCB
,
246 FileObject
->ReadAccess
= TRUE
;
247 FileObject
->WriteAccess
= FALSE
;
248 FileObject
->DeleteAccess
= FALSE
;
249 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
250 FileObject
->FsContext
= Fcb
;
251 FileObject
->FsContext2
= newCCB
;
252 newCCB
->PtrFileObject
= FileObject
;
253 Fcb
->FileObject
= FileObject
;
258 CcInitializeCacheMap(FileObject
,
259 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
261 &(CdfsGlobalData
->CacheMgrCallbacks
),
264 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
266 FileObject
->FsContext2
= NULL
;
267 ExFreePoolWithTag(newCCB
, CDFS_CCB_TAG
);
268 ObDereferenceObject(FileObject
);
269 Fcb
->FileObject
= NULL
;
270 return _SEH2_GetExceptionCode();
274 ObDereferenceObject(FileObject
);
275 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
277 return STATUS_SUCCESS
;
282 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb
)
286 Fcb
= CdfsCreateFCB(L
"\\");
288 Fcb
->Entry
.DataLengthL
= Vcb
->CdInfo
.RootSize
;
289 Fcb
->Entry
.ExtentLocationL
= Vcb
->CdInfo
.RootStart
;
290 Fcb
->Entry
.FileFlags
= FILE_FLAG_DIRECTORY
;
291 Fcb
->IndexNumber
.QuadPart
= 0LL;
294 Fcb
->RFCB
.FileSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
295 Fcb
->RFCB
.ValidDataLength
.QuadPart
= Vcb
->CdInfo
.RootSize
;
296 Fcb
->RFCB
.AllocationSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
298 CdfsFCBInitializeCache(Vcb
, Fcb
);
299 CdfsAddFCBToTable(Vcb
, Fcb
);
300 CdfsGrabFCB(Vcb
, Fcb
);
307 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb
)
309 UNICODE_STRING FileName
;
312 RtlInitUnicodeString(&FileName
, L
"\\");
314 Fcb
= CdfsGrabFCBFromTable(Vcb
,
318 Fcb
= CdfsMakeRootFCB(Vcb
);
326 CdfsMakeFCBFromDirEntry(PVCB Vcb
,
331 ULONG DirectorySector
,
332 ULONG DirectoryOffset
,
335 WCHAR pathName
[MAX_PATH
];
339 /* Check if the full string would overflow the pathName buffer (the additional characters are for '\\' and '\0') */
340 if ((LongName
[0] != 0) &&
341 ((DirectoryFCB
->PathName
.Length
/ sizeof(WCHAR
)) + 1 + wcslen(LongName
) + 1 > MAX_PATH
))
343 return(STATUS_OBJECT_NAME_INVALID
);
346 wcscpy(pathName
, DirectoryFCB
->PathName
.Buffer
);
347 if (!CdfsFCBIsRoot(DirectoryFCB
))
349 wcscat(pathName
, L
"\\");
352 if (LongName
[0] != 0)
354 wcscat(pathName
, LongName
);
358 WCHAR entryName
[MAX_PATH
];
360 CdfsGetDirEntryName(Vcb
, Record
, entryName
);
361 wcscat(pathName
, entryName
);
364 rcFCB
= CdfsCreateFCB(pathName
);
365 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
367 /* Copy short name into FCB */
368 rcFCB
->ShortNameU
.Length
= wcslen(ShortName
) * sizeof(WCHAR
);
369 rcFCB
->ShortNameU
.MaximumLength
= rcFCB
->ShortNameU
.Length
;
370 rcFCB
->ShortNameU
.Buffer
= rcFCB
->ShortNameBuffer
;
371 wcscpy(rcFCB
->ShortNameBuffer
, ShortName
);
373 Size
= rcFCB
->Entry
.DataLengthL
;
375 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
376 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
377 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
378 if (CdfsFCBIsDirectory(rcFCB
))
380 CdfsFCBInitializeCache(Vcb
, rcFCB
);
382 rcFCB
->IndexNumber
.u
.HighPart
= DirectorySector
;
383 rcFCB
->IndexNumber
.u
.LowPart
= DirectoryOffset
;
385 CdfsAddFCBToTable(Vcb
, rcFCB
);
388 DPRINT("%S %u %I64d\n", LongName
, Size
, rcFCB
->RFCB
.AllocationSize
.QuadPart
);
390 return(STATUS_SUCCESS
);
395 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb
,
397 PFILE_OBJECT FileObject
)
401 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), CDFS_CCB_TAG
);
404 return(STATUS_INSUFFICIENT_RESOURCES
);
406 memset(newCCB
, 0, sizeof(CCB
));
408 FileObject
->ReadAccess
= TRUE
;
409 FileObject
->WriteAccess
= FALSE
;
410 FileObject
->DeleteAccess
= FALSE
;
411 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
412 FileObject
->FsContext
= Fcb
;
413 FileObject
->FsContext2
= newCCB
;
414 newCCB
->PtrFileObject
= FileObject
;
417 if (CdfsFCBIsDirectory(Fcb
))
421 CcInitializeCacheMap(FileObject
,
422 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
424 &(CdfsGlobalData
->CacheMgrCallbacks
),
427 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
429 FileObject
->FsContext2
= NULL
;
430 ExFreePoolWithTag(newCCB
, CDFS_CCB_TAG
);
431 return _SEH2_GetExceptionCode();
434 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
437 DPRINT("file open: fcb:%p file size: %u\n", Fcb
, Fcb
->Entry
.DataLengthL
);
439 return(STATUS_SUCCESS
);
444 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt
,
446 PUNICODE_STRING FileToFind
,
449 UNICODE_STRING TempName
;
458 LARGE_INTEGER StreamOffset
, OffsetOfEntry
;
461 WCHAR ShortNameBuffer
[13];
462 UNICODE_STRING ShortName
;
463 UNICODE_STRING LongName
;
464 UNICODE_STRING FileToFindUpcase
;
467 ASSERT(DirectoryFcb
);
470 DPRINT("CdfsDirFindFile(VCB:%p, dirFCB:%p, File:%wZ)\n",
474 DPRINT("Dir Path:%wZ\n", &DirectoryFcb
->PathName
);
476 /* default to '.' if no filename specified */
477 if (FileToFind
->Length
== 0)
479 RtlInitUnicodeString(&TempName
, L
".");
480 FileToFind
= &TempName
;
483 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
484 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
488 CcMapData(DeviceExt
->StreamFileObject
, &StreamOffset
, BLOCKSIZE
, MAP_WAIT
, &Context
, &Block
);
490 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
492 DPRINT("CcMapData() failed\n");
493 _SEH2_YIELD(return _SEH2_GetExceptionCode());
499 Record
= (PDIR_RECORD
)Block
;
501 /* Upper case the expression for FsRtlIsNameInExpression */
502 Status
= RtlUpcaseUnicodeString(&FileToFindUpcase
, FileToFind
, TRUE
);
503 if (!NT_SUCCESS(Status
))
510 if (Record
->RecordLength
== 0)
512 DPRINT("RecordLength == 0 Stopped!\n");
516 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
517 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
519 if (!CdfsIsRecordValid(DeviceExt
, Record
))
521 RtlFreeUnicodeString(&FileToFindUpcase
);
522 CcUnpinData(Context
);
523 return STATUS_DISK_CORRUPT_ERROR
;
526 CdfsGetDirEntryName(DeviceExt
, Record
, Name
);
527 DPRINT ("Name '%S'\n", Name
);
528 DPRINT ("Sector %lu\n", DirectoryFcb
->Entry
.ExtentLocationL
);
529 DPRINT ("Offset %lu\n", Offset
);
531 RtlInitUnicodeString(&LongName
, Name
);
532 RtlInitEmptyUnicodeString(&ShortName
, ShortNameBuffer
, sizeof(ShortNameBuffer
));
533 RtlZeroMemory(ShortNameBuffer
, sizeof(ShortNameBuffer
));
535 OffsetOfEntry
.QuadPart
= StreamOffset
.QuadPart
+ Offset
;
536 CdfsShortNameCacheGet(DirectoryFcb
, &OffsetOfEntry
, &LongName
, &ShortName
);
538 DPRINT("ShortName '%wZ'\n", &ShortName
);
540 ASSERT(LongName
.Length
>= sizeof(WCHAR
));
541 ASSERT(ShortName
.Length
>= sizeof(WCHAR
));
542 if (FsRtlIsNameInExpression(&FileToFindUpcase
, &LongName
, TRUE
, NULL
) ||
543 FsRtlIsNameInExpression(&FileToFindUpcase
, &ShortName
, TRUE
, NULL
))
545 DPRINT("Match found, %S\n", Name
);
546 Status
= CdfsMakeFCBFromDirEntry(DeviceExt
,
551 DirectoryFcb
->Entry
.ExtentLocationL
,
555 RtlFreeUnicodeString(&FileToFindUpcase
);
556 CcUnpinData(Context
);
561 Offset
+= Record
->RecordLength
;
562 BlockOffset
+= Record
->RecordLength
;
563 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
564 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
566 DPRINT("Map next sector\n");
567 CcUnpinData(Context
);
568 StreamOffset
.QuadPart
+= BLOCKSIZE
;
569 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
574 CcMapData(DeviceExt
->StreamFileObject
, &StreamOffset
, BLOCKSIZE
, MAP_WAIT
, &Context
, &Block
);
576 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
578 DPRINT("CcMapData() failed\n");
579 RtlFreeUnicodeString(&FileToFindUpcase
);
580 _SEH2_YIELD(return _SEH2_GetExceptionCode());
583 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
586 if (Offset
>= DirSize
)
590 RtlFreeUnicodeString(&FileToFindUpcase
);
591 CcUnpinData(Context
);
593 return(STATUS_OBJECT_NAME_NOT_FOUND
);
598 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb
,
601 PUNICODE_STRING FileName
)
603 UNICODE_STRING PathName
;
604 UNICODE_STRING NextElement
;
605 UNICODE_STRING CurrentElement
;
610 DPRINT("CdfsGetFCBForFile(%p, %p, %p, '%wZ')\n",
616 /* Trivial case, open of the root directory on volume */
617 if (FileName
->Length
== 0 ||
618 ((FileName
->Buffer
[0] == '\\') && (FileName
->Length
== sizeof(WCHAR
))))
620 DPRINT("returning root FCB\n");
622 FCB
= CdfsOpenRootFCB(Vcb
);
626 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
630 /* Start with empty path */
631 PathName
= *FileName
;
633 CurrentElement
= *FileName
;
635 FCB
= CdfsOpenRootFCB (Vcb
);
639 /* Parse filename and check each path element for existence and access */
640 while (CdfsGetNextPathElement(&CurrentElement
, &NextElement
))
642 /* Skip blank directory levels */
643 if (CurrentElement
.Buffer
[0] == L
'\\')
645 CurrentElement
.Buffer
++;
646 CurrentElement
.Length
-= sizeof(WCHAR
);
647 CurrentElement
.MaximumLength
-= sizeof(WCHAR
);
651 DPRINT("Parsing, currentElement:%wZ\n", &CurrentElement
);
652 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
654 /* Descend to next directory level */
657 CdfsReleaseFCB(Vcb
, parentFCB
);
661 /* fail if element in FCB is not a directory */
662 if (!CdfsFCBIsDirectory(FCB
))
664 DPRINT("Element in requested path is not a directory\n");
666 CdfsReleaseFCB(Vcb
, FCB
);
671 return(STATUS_OBJECT_PATH_NOT_FOUND
);
675 /* Extract next directory level */
676 PathName
.Length
= (NextElement
.Buffer
- FileName
->Buffer
) * sizeof(WCHAR
);
677 DPRINT(" PathName:%wZ\n", &PathName
);
679 FCB
= CdfsGrabFCBFromTable(Vcb
, &PathName
);
682 UNICODE_STRING ChildElement
= CurrentElement
;
683 ChildElement
.Length
= (NextElement
.Buffer
- CurrentElement
.Buffer
) * sizeof(WCHAR
);
685 Status
= CdfsDirFindFile(Vcb
,
689 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
691 *pParentFCB
= parentFCB
;
694 if (NextElement
.Length
== 0)
696 return(STATUS_OBJECT_NAME_NOT_FOUND
);
700 return(STATUS_OBJECT_PATH_NOT_FOUND
);
703 else if (!NT_SUCCESS(Status
))
705 CdfsReleaseFCB(Vcb
, parentFCB
);
712 CurrentElement
= NextElement
;
715 *pParentFCB
= parentFCB
;
718 return STATUS_SUCCESS
;