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
,
74 CDFS_NONPAGED_FCB_TAG
);
77 RtlZeroMemory(Fcb
, sizeof(FCB
));
78 RtlInitEmptyUnicodeString(&Fcb
->PathName
, Fcb
->PathNameBuffer
, sizeof(Fcb
->PathNameBuffer
));
82 RtlAppendUnicodeToString(&Fcb
->PathName
, FileName
);
83 if (wcsrchr(Fcb
->PathName
.Buffer
, '\\') != 0)
85 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
.Buffer
, '\\');
89 Fcb
->ObjectName
= Fcb
->PathName
.Buffer
;
93 ExInitializeResourceLite(&Fcb
->PagingIoResource
);
94 ExInitializeResourceLite(&Fcb
->MainResource
);
95 ExInitializeResourceLite(&Fcb
->NameListResource
);
96 Fcb
->RFCB
.PagingIoResource
= &Fcb
->PagingIoResource
;
97 Fcb
->RFCB
.Resource
= &Fcb
->MainResource
;
98 Fcb
->RFCB
.IsFastIoPossible
= FastIoIsNotPossible
;
99 InitializeListHead(&Fcb
->ShortNameList
);
106 CdfsDestroyFCB(PFCB Fcb
)
110 ExDeleteResourceLite(&Fcb
->PagingIoResource
);
111 ExDeleteResourceLite(&Fcb
->MainResource
);
113 while (!IsListEmpty(&Fcb
->ShortNameList
))
115 Entry
= Fcb
->ShortNameList
.Flink
;
116 RemoveEntryList(Entry
);
117 ExFreePoolWithTag(Entry
, CDFS_SHORT_NAME_TAG
);
120 ExDeleteResourceLite(&Fcb
->NameListResource
);
121 ExFreePoolWithTag(Fcb
, CDFS_NONPAGED_FCB_TAG
);
126 CdfsFCBIsDirectory(PFCB Fcb
)
128 return(Fcb
->Entry
.FileFlags
& FILE_FLAG_DIRECTORY
);
133 CdfsFCBIsRoot(PFCB Fcb
)
135 return (Fcb
->PathName
.Length
== sizeof(WCHAR
) && Fcb
->PathName
.Buffer
[0] == L
'\\');
140 CdfsGrabFCB(PDEVICE_EXTENSION Vcb
,
145 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
150 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
152 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
157 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb
,
162 DPRINT("releasing FCB at %p: %wZ, refCount:%d\n",
167 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
169 if (Fcb
->RefCount
<= 0 && !CdfsFCBIsDirectory(Fcb
))
171 RemoveEntryList(&Fcb
->FcbListEntry
);
174 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
179 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb
,
184 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
186 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
187 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
192 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb
,
193 PUNICODE_STRING FileName
)
197 PLIST_ENTRY current_entry
;
199 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
201 if (FileName
== NULL
|| FileName
->Length
== 0 || FileName
->Buffer
[0] == 0)
203 DPRINT("Return FCB for stream file object\n");
204 Fcb
= Vcb
->StreamFileObject
->FsContext
;
206 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
210 current_entry
= Vcb
->FcbListHead
.Flink
;
211 while (current_entry
!= &Vcb
->FcbListHead
)
213 Fcb
= CONTAINING_RECORD(current_entry
, FCB
, FcbListEntry
);
215 DPRINT("Comparing '%wZ' and '%wZ'\n", FileName
, &Fcb
->PathName
);
216 if (RtlCompareUnicodeString(FileName
, &Fcb
->PathName
, TRUE
) == 0)
219 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
223 //FIXME: need to compare against short name in FCB here
225 current_entry
= current_entry
->Flink
;
227 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
234 CdfsFCBInitializeCache(PVCB Vcb
,
237 PFILE_OBJECT FileObject
;
240 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
242 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), CDFS_CCB_TAG
);
245 return STATUS_INSUFFICIENT_RESOURCES
;
247 RtlZeroMemory(newCCB
,
250 FileObject
->ReadAccess
= TRUE
;
251 FileObject
->WriteAccess
= FALSE
;
252 FileObject
->DeleteAccess
= FALSE
;
253 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
254 FileObject
->FsContext
= Fcb
;
255 FileObject
->FsContext2
= newCCB
;
256 newCCB
->PtrFileObject
= FileObject
;
257 Fcb
->FileObject
= FileObject
;
262 CcInitializeCacheMap(FileObject
,
263 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
265 &(CdfsGlobalData
->CacheMgrCallbacks
),
268 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
270 FileObject
->FsContext2
= NULL
;
271 ExFreePoolWithTag(newCCB
, CDFS_CCB_TAG
);
272 ObDereferenceObject(FileObject
);
273 Fcb
->FileObject
= NULL
;
274 return _SEH2_GetExceptionCode();
278 ObDereferenceObject(FileObject
);
279 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
281 return STATUS_SUCCESS
;
286 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb
)
290 Fcb
= CdfsCreateFCB(L
"\\");
292 Fcb
->Entry
.DataLengthL
= Vcb
->CdInfo
.RootSize
;
293 Fcb
->Entry
.ExtentLocationL
= Vcb
->CdInfo
.RootStart
;
294 Fcb
->Entry
.FileFlags
= FILE_FLAG_DIRECTORY
;
295 Fcb
->IndexNumber
.QuadPart
= 0LL;
298 Fcb
->RFCB
.FileSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
299 Fcb
->RFCB
.ValidDataLength
.QuadPart
= Vcb
->CdInfo
.RootSize
;
300 Fcb
->RFCB
.AllocationSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
302 CdfsFCBInitializeCache(Vcb
, Fcb
);
303 CdfsAddFCBToTable(Vcb
, Fcb
);
304 CdfsGrabFCB(Vcb
, Fcb
);
311 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb
)
313 UNICODE_STRING FileName
;
316 RtlInitUnicodeString(&FileName
, L
"\\");
318 Fcb
= CdfsGrabFCBFromTable(Vcb
,
322 Fcb
= CdfsMakeRootFCB(Vcb
);
330 CdfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
334 * FUNCTION: Retrieves the file name from a directory record.
337 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
341 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
347 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
351 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
352 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
359 Record
->FileIdLength
);
363 DPRINT("Name '%S'\n", Name
);
368 CdfsMakeFCBFromDirEntry(PVCB Vcb
,
373 ULONG DirectorySector
,
374 ULONG DirectoryOffset
,
377 WCHAR pathName
[MAX_PATH
];
381 /* Check if the full string would overflow the pathName buffer (the additional characters are for '\\' and '\0') */
382 if ((LongName
[0] != 0) &&
383 ((DirectoryFCB
->PathName
.Length
/ sizeof(WCHAR
)) + 1 + wcslen(LongName
) + 1 > MAX_PATH
))
385 return(STATUS_OBJECT_NAME_INVALID
);
388 wcscpy(pathName
, DirectoryFCB
->PathName
.Buffer
);
389 if (!CdfsFCBIsRoot(DirectoryFCB
))
391 wcscat(pathName
, L
"\\");
394 if (LongName
[0] != 0)
396 wcscat(pathName
, LongName
);
400 WCHAR entryName
[MAX_PATH
];
402 CdfsGetDirEntryName(Vcb
, Record
, entryName
);
403 wcscat(pathName
, entryName
);
406 rcFCB
= CdfsCreateFCB(pathName
);
407 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
409 /* Copy short name into FCB */
410 rcFCB
->ShortNameU
.Length
= wcslen(ShortName
) * sizeof(WCHAR
);
411 rcFCB
->ShortNameU
.MaximumLength
= rcFCB
->ShortNameU
.Length
;
412 rcFCB
->ShortNameU
.Buffer
= rcFCB
->ShortNameBuffer
;
413 wcscpy(rcFCB
->ShortNameBuffer
, ShortName
);
415 Size
= rcFCB
->Entry
.DataLengthL
;
417 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
418 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
419 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
420 if (CdfsFCBIsDirectory(rcFCB
))
422 CdfsFCBInitializeCache(Vcb
, rcFCB
);
424 rcFCB
->IndexNumber
.u
.HighPart
= DirectorySector
;
425 rcFCB
->IndexNumber
.u
.LowPart
= DirectoryOffset
;
427 CdfsAddFCBToTable(Vcb
, rcFCB
);
430 DPRINT("%S %u %I64d\n", LongName
, Size
, rcFCB
->RFCB
.AllocationSize
.QuadPart
);
432 return(STATUS_SUCCESS
);
437 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb
,
439 PFILE_OBJECT FileObject
)
443 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), CDFS_CCB_TAG
);
446 return(STATUS_INSUFFICIENT_RESOURCES
);
448 memset(newCCB
, 0, sizeof(CCB
));
450 FileObject
->ReadAccess
= TRUE
;
451 FileObject
->WriteAccess
= FALSE
;
452 FileObject
->DeleteAccess
= FALSE
;
453 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
454 FileObject
->FsContext
= Fcb
;
455 FileObject
->FsContext2
= newCCB
;
456 newCCB
->PtrFileObject
= FileObject
;
459 if (CdfsFCBIsDirectory(Fcb
))
463 CcInitializeCacheMap(FileObject
,
464 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
466 &(CdfsGlobalData
->CacheMgrCallbacks
),
469 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
471 FileObject
->FsContext2
= NULL
;
472 ExFreePoolWithTag(newCCB
, CDFS_CCB_TAG
);
473 return _SEH2_GetExceptionCode();
476 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
479 DPRINT("file open: fcb:%p file size: %u\n", Fcb
, Fcb
->Entry
.DataLengthL
);
481 return(STATUS_SUCCESS
);
486 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt
,
488 PUNICODE_STRING FileToFind
,
491 UNICODE_STRING TempName
;
500 LARGE_INTEGER StreamOffset
, OffsetOfEntry
;
503 WCHAR ShortNameBuffer
[13];
504 UNICODE_STRING ShortName
;
505 UNICODE_STRING LongName
;
506 UNICODE_STRING FileToFindUpcase
;
509 ASSERT(DirectoryFcb
);
512 DPRINT("CdfsDirFindFile(VCB:%p, dirFCB:%p, File:%wZ)\n",
516 DPRINT("Dir Path:%wZ\n", &DirectoryFcb
->PathName
);
518 /* default to '.' if no filename specified */
519 if (FileToFind
->Length
== 0)
521 RtlInitUnicodeString(&TempName
, L
".");
522 FileToFind
= &TempName
;
525 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
526 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
528 if (!CcMapData(DeviceExt
->StreamFileObject
,
535 DPRINT("CcMapData() failed\n");
536 return STATUS_UNSUCCESSFUL
;
541 Record
= (PDIR_RECORD
)Block
;
543 /* Upper case the expression for FsRtlIsNameInExpression */
544 Status
= RtlUpcaseUnicodeString(&FileToFindUpcase
, FileToFind
, TRUE
);
545 if (!NT_SUCCESS(Status
))
552 if (Record
->RecordLength
== 0)
554 DPRINT("RecordLength == 0 Stopped!\n");
558 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
559 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
561 CdfsGetDirEntryName(DeviceExt
, Record
, Name
);
562 DPRINT ("Name '%S'\n", Name
);
563 DPRINT ("Sector %lu\n", DirectoryFcb
->Entry
.ExtentLocationL
);
564 DPRINT ("Offset %lu\n", Offset
);
566 RtlInitUnicodeString(&LongName
, Name
);
567 RtlInitEmptyUnicodeString(&ShortName
, ShortNameBuffer
, sizeof(ShortNameBuffer
));
568 RtlZeroMemory(ShortNameBuffer
, sizeof(ShortNameBuffer
));
570 OffsetOfEntry
.QuadPart
= StreamOffset
.QuadPart
+ Offset
;
571 CdfsShortNameCacheGet(DirectoryFcb
, &OffsetOfEntry
, &LongName
, &ShortName
);
573 DPRINT("ShortName '%wZ'\n", &ShortName
);
575 ASSERT(LongName
.Length
>= sizeof(WCHAR
));
576 ASSERT(ShortName
.Length
>= sizeof(WCHAR
));
577 if (FsRtlIsNameInExpression(&FileToFindUpcase
, &LongName
, TRUE
, NULL
) ||
578 FsRtlIsNameInExpression(&FileToFindUpcase
, &ShortName
, TRUE
, NULL
))
580 DPRINT("Match found, %S\n", Name
);
581 Status
= CdfsMakeFCBFromDirEntry(DeviceExt
,
586 DirectoryFcb
->Entry
.ExtentLocationL
,
590 RtlFreeUnicodeString(&FileToFindUpcase
);
591 CcUnpinData(Context
);
596 Offset
+= Record
->RecordLength
;
597 BlockOffset
+= Record
->RecordLength
;
598 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
599 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
601 DPRINT("Map next sector\n");
602 CcUnpinData(Context
);
603 StreamOffset
.QuadPart
+= BLOCKSIZE
;
604 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
607 if (!CcMapData(DeviceExt
->StreamFileObject
,
612 DPRINT("CcMapData() failed\n");
613 RtlFreeUnicodeString(&FileToFindUpcase
);
614 return(STATUS_UNSUCCESSFUL
);
616 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
619 if (Offset
>= DirSize
)
623 RtlFreeUnicodeString(&FileToFindUpcase
);
624 CcUnpinData(Context
);
626 return(STATUS_OBJECT_NAME_NOT_FOUND
);
631 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb
,
634 PUNICODE_STRING FileName
)
636 UNICODE_STRING PathName
;
637 UNICODE_STRING ElementName
;
639 WCHAR pathName
[MAX_PATH
];
640 WCHAR elementName
[MAX_PATH
];
641 PWCHAR currentElement
;
645 DPRINT("CdfsGetFCBForFile(%p, %p, %p, '%wZ')\n",
651 /* Trivial case, open of the root directory on volume */
652 if (FileName
->Buffer
[0] == L
'\0' || wcscmp(FileName
->Buffer
, L
"\\") == 0)
654 DPRINT("returning root FCB\n");
656 FCB
= CdfsOpenRootFCB(Vcb
);
660 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
664 currentElement
= &FileName
->Buffer
[1];
665 wcscpy (pathName
, L
"\\");
666 FCB
= CdfsOpenRootFCB (Vcb
);
670 /* Parse filename and check each path element for existance and access */
671 while (CdfsGetNextPathElement(currentElement
) != 0)
673 /* Skip blank directory levels */
674 if ((CdfsGetNextPathElement(currentElement
) - currentElement
) == 0)
680 DPRINT("Parsing, currentElement:%S\n", currentElement
);
681 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
683 /* Descend to next directory level */
686 CdfsReleaseFCB(Vcb
, parentFCB
);
690 /* fail if element in FCB is not a directory */
691 if (!CdfsFCBIsDirectory(FCB
))
693 DPRINT("Element in requested path is not a directory\n");
695 CdfsReleaseFCB(Vcb
, FCB
);
700 return(STATUS_OBJECT_PATH_NOT_FOUND
);
704 /* Extract next directory level into dirName */
705 CdfsWSubString(pathName
,
707 CdfsGetNextPathElement(currentElement
) - FileName
->Buffer
);
708 DPRINT(" pathName:%S\n", pathName
);
710 RtlInitUnicodeString(&PathName
, pathName
);
712 FCB
= CdfsGrabFCBFromTable(Vcb
, &PathName
);
715 CdfsWSubString(elementName
,
717 CdfsGetNextPathElement(currentElement
) - currentElement
);
718 DPRINT(" elementName:%S\n", elementName
);
720 RtlInitUnicodeString(&ElementName
, elementName
);
721 Status
= CdfsDirFindFile(Vcb
,
725 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
727 *pParentFCB
= parentFCB
;
729 currentElement
= CdfsGetNextPathElement(currentElement
);
730 if (*currentElement
== L
'\0' || CdfsGetNextPathElement(currentElement
+ 1) == 0)
732 return(STATUS_OBJECT_NAME_NOT_FOUND
);
736 return(STATUS_OBJECT_PATH_NOT_FOUND
);
739 else if (!NT_SUCCESS(Status
))
741 CdfsReleaseFCB(Vcb
, parentFCB
);
748 currentElement
= CdfsGetNextPathElement(currentElement
);
751 *pParentFCB
= parentFCB
;
754 return STATUS_SUCCESS
;