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: services/fs/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(PWCHAR FileName
)
45 if (*FileName
== L
'\0')
50 while (*FileName
!= L
'\0' && *FileName
!= L
'\\')
60 CdfsWSubString(LPWSTR pTarget
, LPCWSTR pSource
, size_t pLength
)
62 wcsncpy (pTarget
, pSource
, pLength
);
63 pTarget
[pLength
] = L
'\0';
68 CdfsCreateFCB(PCWSTR FileName
)
72 Fcb
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(FCB
), TAG_FCB
);
75 RtlZeroMemory(Fcb
, sizeof(FCB
));
76 RtlInitEmptyUnicodeString(&Fcb
->PathName
, Fcb
->PathNameBuffer
, sizeof(Fcb
->PathNameBuffer
));
80 RtlAppendUnicodeToString(&Fcb
->PathName
, FileName
);
81 if (wcsrchr(Fcb
->PathName
.Buffer
, '\\') != 0)
83 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
.Buffer
, '\\');
87 Fcb
->ObjectName
= Fcb
->PathName
.Buffer
;
91 ExInitializeResourceLite(&Fcb
->PagingIoResource
);
92 ExInitializeResourceLite(&Fcb
->MainResource
);
93 ExInitializeResourceLite(&Fcb
->NameListResource
);
94 Fcb
->RFCB
.PagingIoResource
= &Fcb
->PagingIoResource
;
95 Fcb
->RFCB
.Resource
= &Fcb
->MainResource
;
96 Fcb
->RFCB
.IsFastIoPossible
= FastIoIsNotPossible
;
97 InitializeListHead(&Fcb
->ShortNameList
);
104 CdfsDestroyFCB(PFCB Fcb
)
108 ExDeleteResourceLite(&Fcb
->PagingIoResource
);
109 ExDeleteResourceLite(&Fcb
->MainResource
);
111 while (!IsListEmpty(&Fcb
->ShortNameList
))
113 Entry
= Fcb
->ShortNameList
.Flink
;
114 RemoveEntryList(Entry
);
115 ExFreePoolWithTag(Entry
, TAG_FCB
);
118 ExDeleteResourceLite(&Fcb
->NameListResource
);
119 ExFreePoolWithTag(Fcb
, TAG_FCB
);
124 CdfsFCBIsDirectory(PFCB Fcb
)
126 return(Fcb
->Entry
.FileFlags
& FILE_FLAG_DIRECTORY
);
131 CdfsFCBIsRoot(PFCB Fcb
)
133 return (Fcb
->PathName
.Length
== sizeof(WCHAR
) && Fcb
->PathName
.Buffer
[0] == L
'\\');
138 CdfsGrabFCB(PDEVICE_EXTENSION Vcb
,
143 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
148 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
150 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
155 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb
,
160 DPRINT("releasing FCB at %p: %wZ, refCount:%d\n",
165 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
167 if (Fcb
->RefCount
<= 0 && !CdfsFCBIsDirectory(Fcb
))
169 RemoveEntryList(&Fcb
->FcbListEntry
);
172 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
177 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb
,
182 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
184 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
185 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
190 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb
,
191 PUNICODE_STRING FileName
)
195 PLIST_ENTRY current_entry
;
197 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
199 if (FileName
== NULL
|| FileName
->Length
== 0 || FileName
->Buffer
[0] == 0)
201 DPRINT("Return FCB for stream file object\n");
202 Fcb
= Vcb
->StreamFileObject
->FsContext
;
204 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
208 current_entry
= Vcb
->FcbListHead
.Flink
;
209 while (current_entry
!= &Vcb
->FcbListHead
)
211 Fcb
= CONTAINING_RECORD(current_entry
, FCB
, FcbListEntry
);
213 DPRINT("Comparing '%wZ' and '%wZ'\n", FileName
, &Fcb
->PathName
);
214 if (RtlCompareUnicodeString(FileName
, &Fcb
->PathName
, TRUE
) == 0)
217 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
221 //FIXME: need to compare against short name in FCB here
223 current_entry
= current_entry
->Flink
;
225 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
232 CdfsFCBInitializeCache(PVCB Vcb
,
235 PFILE_OBJECT FileObject
;
238 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
240 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
243 return STATUS_INSUFFICIENT_RESOURCES
;
245 RtlZeroMemory(newCCB
,
248 FileObject
->ReadAccess
= TRUE
;
249 FileObject
->WriteAccess
= FALSE
;
250 FileObject
->DeleteAccess
= FALSE
;
251 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
252 FileObject
->FsContext
= Fcb
;
253 FileObject
->FsContext2
= newCCB
;
254 newCCB
->PtrFileObject
= FileObject
;
255 Fcb
->FileObject
= FileObject
;
260 CcInitializeCacheMap(FileObject
,
261 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
263 &(CdfsGlobalData
->CacheMgrCallbacks
),
266 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
268 FileObject
->FsContext2
= NULL
;
269 ExFreePoolWithTag(newCCB
, TAG_CCB
);
270 ObDereferenceObject(FileObject
);
271 Fcb
->FileObject
= NULL
;
272 return _SEH2_GetExceptionCode();
276 ObDereferenceObject(FileObject
);
277 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
279 return STATUS_SUCCESS
;
284 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb
)
288 Fcb
= CdfsCreateFCB(L
"\\");
290 Fcb
->Entry
.DataLengthL
= Vcb
->CdInfo
.RootSize
;
291 Fcb
->Entry
.ExtentLocationL
= Vcb
->CdInfo
.RootStart
;
292 Fcb
->Entry
.FileFlags
= FILE_FLAG_DIRECTORY
;
293 Fcb
->IndexNumber
.QuadPart
= 0LL;
296 Fcb
->RFCB
.FileSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
297 Fcb
->RFCB
.ValidDataLength
.QuadPart
= Vcb
->CdInfo
.RootSize
;
298 Fcb
->RFCB
.AllocationSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
300 CdfsFCBInitializeCache(Vcb
, Fcb
);
301 CdfsAddFCBToTable(Vcb
, Fcb
);
302 CdfsGrabFCB(Vcb
, Fcb
);
309 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb
)
311 UNICODE_STRING FileName
;
314 RtlInitUnicodeString(&FileName
, L
"\\");
316 Fcb
= CdfsGrabFCBFromTable(Vcb
,
320 Fcb
= CdfsMakeRootFCB(Vcb
);
328 CdfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
332 * FUNCTION: Retrieves the file name from a directory record.
335 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
339 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
345 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
349 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
350 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
357 Record
->FileIdLength
);
361 DPRINT("Name '%S'\n", Name
);
366 CdfsMakeFCBFromDirEntry(PVCB Vcb
,
371 ULONG DirectorySector
,
372 ULONG DirectoryOffset
,
375 WCHAR pathName
[MAX_PATH
];
379 /* Check if the full string would overflow the pathName buffer (the additional characters are for '\\' and '\0') */
380 if ((LongName
[0] != 0) &&
381 ((DirectoryFCB
->PathName
.Length
/ sizeof(WCHAR
)) + 1 + wcslen(LongName
) + 1 > MAX_PATH
))
383 return(STATUS_OBJECT_NAME_INVALID
);
386 wcscpy(pathName
, DirectoryFCB
->PathName
.Buffer
);
387 if (!CdfsFCBIsRoot(DirectoryFCB
))
389 wcscat(pathName
, L
"\\");
392 if (LongName
[0] != 0)
394 wcscat(pathName
, LongName
);
398 WCHAR entryName
[MAX_PATH
];
400 CdfsGetDirEntryName(Vcb
, Record
, entryName
);
401 wcscat(pathName
, entryName
);
404 rcFCB
= CdfsCreateFCB(pathName
);
405 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
407 /* Copy short name into FCB */
408 rcFCB
->ShortNameU
.Length
= wcslen(ShortName
) * sizeof(WCHAR
);
409 rcFCB
->ShortNameU
.MaximumLength
= rcFCB
->ShortNameU
.Length
;
410 rcFCB
->ShortNameU
.Buffer
= rcFCB
->ShortNameBuffer
;
411 wcscpy(rcFCB
->ShortNameBuffer
, ShortName
);
413 Size
= rcFCB
->Entry
.DataLengthL
;
415 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
416 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
417 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
418 if (CdfsFCBIsDirectory(rcFCB
))
420 CdfsFCBInitializeCache(Vcb
, rcFCB
);
422 rcFCB
->IndexNumber
.u
.HighPart
= DirectorySector
;
423 rcFCB
->IndexNumber
.u
.LowPart
= DirectoryOffset
;
425 CdfsAddFCBToTable(Vcb
, rcFCB
);
428 DPRINT("%S %u %I64d\n", LongName
, Size
, rcFCB
->RFCB
.AllocationSize
.QuadPart
);
430 return(STATUS_SUCCESS
);
435 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb
,
437 PFILE_OBJECT FileObject
)
441 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
444 return(STATUS_INSUFFICIENT_RESOURCES
);
446 memset(newCCB
, 0, sizeof(CCB
));
448 FileObject
->ReadAccess
= TRUE
;
449 FileObject
->WriteAccess
= FALSE
;
450 FileObject
->DeleteAccess
= FALSE
;
451 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
452 FileObject
->FsContext
= Fcb
;
453 FileObject
->FsContext2
= newCCB
;
454 newCCB
->PtrFileObject
= FileObject
;
457 if (CdfsFCBIsDirectory(Fcb
))
461 CcInitializeCacheMap(FileObject
,
462 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
464 &(CdfsGlobalData
->CacheMgrCallbacks
),
467 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
469 FileObject
->FsContext2
= NULL
;
470 ExFreePoolWithTag(newCCB
, TAG_CCB
);
471 return _SEH2_GetExceptionCode();
474 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
477 DPRINT("file open: fcb:%p file size: %u\n", Fcb
, Fcb
->Entry
.DataLengthL
);
479 return(STATUS_SUCCESS
);
484 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt
,
486 PUNICODE_STRING FileToFind
,
489 UNICODE_STRING TempName
;
498 LARGE_INTEGER StreamOffset
, OffsetOfEntry
;
501 WCHAR ShortNameBuffer
[13];
502 UNICODE_STRING ShortName
;
503 UNICODE_STRING LongName
;
504 UNICODE_STRING FileToFindUpcase
;
507 ASSERT(DirectoryFcb
);
510 DPRINT("CdfsDirFindFile(VCB:%p, dirFCB:%p, File:%wZ)\n",
514 DPRINT("Dir Path:%wZ\n", &DirectoryFcb
->PathName
);
516 /* default to '.' if no filename specified */
517 if (FileToFind
->Length
== 0)
519 RtlInitUnicodeString(&TempName
, L
".");
520 FileToFind
= &TempName
;
523 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
524 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
526 if (!CcMapData(DeviceExt
->StreamFileObject
,
533 DPRINT("CcMapData() failed\n");
534 return STATUS_UNSUCCESSFUL
;
539 Record
= (PDIR_RECORD
)Block
;
541 /* Upper case the expression for FsRtlIsNameInExpression */
542 Status
= RtlUpcaseUnicodeString(&FileToFindUpcase
, FileToFind
, TRUE
);
543 if (!NT_SUCCESS(Status
))
550 if (Record
->RecordLength
== 0)
552 DPRINT("RecordLength == 0 Stopped!\n");
556 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
557 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
559 CdfsGetDirEntryName(DeviceExt
, Record
, Name
);
560 DPRINT ("Name '%S'\n", Name
);
561 DPRINT ("Sector %lu\n", DirectoryFcb
->Entry
.ExtentLocationL
);
562 DPRINT ("Offset %lu\n", Offset
);
564 RtlInitUnicodeString(&LongName
, Name
);
565 ShortName
.Length
= 0;
566 ShortName
.MaximumLength
= 26;
567 ShortName
.Buffer
= ShortNameBuffer
;
568 memset(ShortNameBuffer
, 0, 26);
570 OffsetOfEntry
.QuadPart
= StreamOffset
.QuadPart
+ Offset
;
571 CdfsShortNameCacheGet(DirectoryFcb
, &OffsetOfEntry
, &LongName
, &ShortName
);
573 DPRINT("ShortName '%wZ'\n", &ShortName
);
575 if (FsRtlIsNameInExpression(&FileToFindUpcase
, &LongName
, TRUE
, NULL
) ||
576 FsRtlIsNameInExpression(&FileToFindUpcase
, &ShortName
, TRUE
, NULL
))
578 DPRINT("Match found, %S\n", Name
);
579 Status
= CdfsMakeFCBFromDirEntry(DeviceExt
,
584 DirectoryFcb
->Entry
.ExtentLocationL
,
588 RtlFreeUnicodeString(&FileToFindUpcase
);
589 CcUnpinData(Context
);
594 Offset
+= Record
->RecordLength
;
595 BlockOffset
+= Record
->RecordLength
;
596 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
597 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
599 DPRINT("Map next sector\n");
600 CcUnpinData(Context
);
601 StreamOffset
.QuadPart
+= BLOCKSIZE
;
602 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
605 if (!CcMapData(DeviceExt
->StreamFileObject
,
610 DPRINT("CcMapData() failed\n");
611 RtlFreeUnicodeString(&FileToFindUpcase
);
612 return(STATUS_UNSUCCESSFUL
);
614 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
617 if (Offset
>= DirSize
)
621 RtlFreeUnicodeString(&FileToFindUpcase
);
622 CcUnpinData(Context
);
624 return(STATUS_OBJECT_NAME_NOT_FOUND
);
629 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb
,
632 PUNICODE_STRING FileName
)
634 UNICODE_STRING PathName
;
635 UNICODE_STRING ElementName
;
637 WCHAR pathName
[MAX_PATH
];
638 WCHAR elementName
[MAX_PATH
];
639 PWCHAR currentElement
;
643 DPRINT("CdfsGetFCBForFile(%p, %p, %p, '%wZ')\n",
649 /* Trivial case, open of the root directory on volume */
650 if (FileName
->Buffer
[0] == L
'\0' || wcscmp(FileName
->Buffer
, L
"\\") == 0)
652 DPRINT("returning root FCB\n");
654 FCB
= CdfsOpenRootFCB(Vcb
);
658 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
662 currentElement
= &FileName
->Buffer
[1];
663 wcscpy (pathName
, L
"\\");
664 FCB
= CdfsOpenRootFCB (Vcb
);
668 /* Parse filename and check each path element for existance and access */
669 while (CdfsGetNextPathElement(currentElement
) != 0)
671 /* Skip blank directory levels */
672 if ((CdfsGetNextPathElement(currentElement
) - currentElement
) == 0)
678 DPRINT("Parsing, currentElement:%S\n", currentElement
);
679 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
681 /* Descend to next directory level */
684 CdfsReleaseFCB(Vcb
, parentFCB
);
688 /* fail if element in FCB is not a directory */
689 if (!CdfsFCBIsDirectory(FCB
))
691 DPRINT("Element in requested path is not a directory\n");
693 CdfsReleaseFCB(Vcb
, FCB
);
698 return(STATUS_OBJECT_PATH_NOT_FOUND
);
702 /* Extract next directory level into dirName */
703 CdfsWSubString(pathName
,
705 CdfsGetNextPathElement(currentElement
) - FileName
->Buffer
);
706 DPRINT(" pathName:%S\n", pathName
);
708 RtlInitUnicodeString(&PathName
, pathName
);
710 FCB
= CdfsGrabFCBFromTable(Vcb
, &PathName
);
713 CdfsWSubString(elementName
,
715 CdfsGetNextPathElement(currentElement
) - currentElement
);
716 DPRINT(" elementName:%S\n", elementName
);
718 RtlInitUnicodeString(&ElementName
, elementName
);
719 Status
= CdfsDirFindFile(Vcb
,
723 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
725 *pParentFCB
= parentFCB
;
727 currentElement
= CdfsGetNextPathElement(currentElement
);
728 if (*currentElement
== L
'\0' || CdfsGetNextPathElement(currentElement
+ 1) == 0)
730 return(STATUS_OBJECT_NAME_NOT_FOUND
);
734 return(STATUS_OBJECT_PATH_NOT_FOUND
);
737 else if (!NT_SUCCESS(Status
))
739 CdfsReleaseFCB(Vcb
, parentFCB
);
746 currentElement
= CdfsGetNextPathElement(currentElement
);
749 *pParentFCB
= parentFCB
;
752 return STATUS_SUCCESS
;