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 Fcb
->PathName
.Buffer
= Fcb
->PathNameBuffer
;
77 Fcb
->PathName
.MaximumLength
= sizeof(Fcb
->PathNameBuffer
);
81 RtlAppendUnicodeToString(&Fcb
->PathName
, FileName
);
82 if (wcsrchr(Fcb
->PathName
.Buffer
, '\\') != 0)
84 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
.Buffer
, '\\');
88 Fcb
->ObjectName
= Fcb
->PathName
.Buffer
;
92 ExInitializeResourceLite(&Fcb
->PagingIoResource
);
93 ExInitializeResourceLite(&Fcb
->MainResource
);
94 ExInitializeResourceLite(&Fcb
->NameListResource
);
95 Fcb
->RFCB
.PagingIoResource
= &Fcb
->PagingIoResource
;
96 Fcb
->RFCB
.Resource
= &Fcb
->MainResource
;
97 Fcb
->RFCB
.IsFastIoPossible
= FastIoIsNotPossible
;
98 InitializeListHead(&Fcb
->ShortNameList
);
105 CdfsDestroyFCB(PFCB Fcb
)
109 ExDeleteResourceLite(&Fcb
->PagingIoResource
);
110 ExDeleteResourceLite(&Fcb
->MainResource
);
112 while (!IsListEmpty(&Fcb
->ShortNameList
))
114 Entry
= Fcb
->ShortNameList
.Flink
;
115 RemoveEntryList(Entry
);
116 ExFreePoolWithTag(Entry
, TAG_FCB
);
119 ExDeleteResourceLite(&Fcb
->NameListResource
);
120 ExFreePoolWithTag(Fcb
, TAG_FCB
);
125 CdfsFCBIsDirectory(PFCB Fcb
)
127 return(Fcb
->Entry
.FileFlags
& FILE_FLAG_DIRECTORY
);
132 CdfsFCBIsRoot(PFCB Fcb
)
134 return (Fcb
->PathName
.Length
= sizeof(WCHAR
) && Fcb
->PathName
.Buffer
[0] == L
'\\');
139 CdfsGrabFCB(PDEVICE_EXTENSION Vcb
,
144 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
149 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
151 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
156 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb
,
161 DPRINT("releasing FCB at %p: %wZ, refCount:%d\n",
166 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
168 if (Fcb
->RefCount
<= 0 && !CdfsFCBIsDirectory(Fcb
))
170 RemoveEntryList(&Fcb
->FcbListEntry
);
173 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
178 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb
,
183 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
185 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
186 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
191 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb
,
192 PUNICODE_STRING FileName
)
196 PLIST_ENTRY current_entry
;
198 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
200 if (FileName
== NULL
|| FileName
->Length
== 0 || FileName
->Buffer
[0] == 0)
202 DPRINT("Return FCB for stream file object\n");
203 Fcb
= Vcb
->StreamFileObject
->FsContext
;
205 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
209 current_entry
= Vcb
->FcbListHead
.Flink
;
210 while (current_entry
!= &Vcb
->FcbListHead
)
212 Fcb
= CONTAINING_RECORD(current_entry
, FCB
, FcbListEntry
);
214 DPRINT("Comparing '%wZ' and '%wZ'\n", FileName
, &Fcb
->PathName
);
215 if (RtlCompareUnicodeString(FileName
, &Fcb
->PathName
, TRUE
) == 0)
218 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
222 //FIXME: need to compare against short name in FCB here
224 current_entry
= current_entry
->Flink
;
226 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
233 CdfsFCBInitializeCache(PVCB Vcb
,
236 PFILE_OBJECT FileObject
;
239 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
241 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
244 return STATUS_INSUFFICIENT_RESOURCES
;
246 RtlZeroMemory(newCCB
,
249 FileObject
->ReadAccess
= TRUE
;
250 FileObject
->WriteAccess
= FALSE
;
251 FileObject
->DeleteAccess
= FALSE
;
252 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
253 FileObject
->FsContext
= Fcb
;
254 FileObject
->FsContext2
= newCCB
;
255 newCCB
->PtrFileObject
= FileObject
;
256 Fcb
->FileObject
= FileObject
;
259 CcInitializeCacheMap(FileObject
,
260 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
262 &(CdfsGlobalData
->CacheMgrCallbacks
),
265 ObDereferenceObject(FileObject
);
266 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
268 return STATUS_SUCCESS
;
273 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb
)
277 Fcb
= CdfsCreateFCB(L
"\\");
279 Fcb
->Entry
.DataLengthL
= Vcb
->CdInfo
.RootSize
;
280 Fcb
->Entry
.ExtentLocationL
= Vcb
->CdInfo
.RootStart
;
281 Fcb
->Entry
.FileFlags
= FILE_FLAG_DIRECTORY
;
282 Fcb
->IndexNumber
.QuadPart
= 0LL;
285 Fcb
->RFCB
.FileSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
286 Fcb
->RFCB
.ValidDataLength
.QuadPart
= Vcb
->CdInfo
.RootSize
;
287 Fcb
->RFCB
.AllocationSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
289 CdfsFCBInitializeCache(Vcb
, Fcb
);
290 CdfsAddFCBToTable(Vcb
, Fcb
);
291 CdfsGrabFCB(Vcb
, Fcb
);
298 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb
)
300 UNICODE_STRING FileName
;
303 RtlInitUnicodeString(&FileName
, L
"\\");
305 Fcb
= CdfsGrabFCBFromTable(Vcb
,
309 Fcb
= CdfsMakeRootFCB(Vcb
);
317 CdfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
321 * FUNCTION: Retrieves the file name from a directory record.
324 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
328 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
334 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
338 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
339 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
346 Record
->FileIdLength
);
350 DPRINT("Name '%S'\n", Name
);
355 CdfsMakeFCBFromDirEntry(PVCB Vcb
,
360 ULONG DirectorySector
,
361 ULONG DirectoryOffset
,
364 WCHAR pathName
[MAX_PATH
];
368 /* Check if the full string would overflow the pathName buffer (the additional characters are for '\\' and '\0') */
369 if ((LongName
[0] != 0) &&
370 ((DirectoryFCB
->PathName
.Length
/ sizeof(WCHAR
)) + 1 + wcslen(LongName
) + 1 > MAX_PATH
))
372 return(STATUS_OBJECT_NAME_INVALID
);
375 wcscpy(pathName
, DirectoryFCB
->PathName
.Buffer
);
376 if (!CdfsFCBIsRoot(DirectoryFCB
))
378 wcscat(pathName
, L
"\\");
381 if (LongName
[0] != 0)
383 wcscat(pathName
, LongName
);
387 WCHAR entryName
[MAX_PATH
];
389 CdfsGetDirEntryName(Vcb
, Record
, entryName
);
390 wcscat(pathName
, entryName
);
393 rcFCB
= CdfsCreateFCB(pathName
);
394 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
396 /* Copy short name into FCB */
397 rcFCB
->ShortNameU
.Length
= wcslen(ShortName
) * sizeof(WCHAR
);
398 rcFCB
->ShortNameU
.MaximumLength
= rcFCB
->ShortNameU
.Length
;
399 rcFCB
->ShortNameU
.Buffer
= rcFCB
->ShortNameBuffer
;
400 wcscpy(rcFCB
->ShortNameBuffer
, ShortName
);
402 Size
= rcFCB
->Entry
.DataLengthL
;
404 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
405 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
406 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
407 if (CdfsFCBIsDirectory(rcFCB
))
409 CdfsFCBInitializeCache(Vcb
, rcFCB
);
411 rcFCB
->IndexNumber
.u
.HighPart
= DirectorySector
;
412 rcFCB
->IndexNumber
.u
.LowPart
= DirectoryOffset
;
414 CdfsAddFCBToTable(Vcb
, rcFCB
);
417 DPRINT("%S %u %I64d\n", LongName
, Size
, rcFCB
->RFCB
.AllocationSize
.QuadPart
);
419 return(STATUS_SUCCESS
);
424 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb
,
426 PFILE_OBJECT FileObject
)
430 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
433 return(STATUS_INSUFFICIENT_RESOURCES
);
435 memset(newCCB
, 0, sizeof(CCB
));
437 FileObject
->ReadAccess
= TRUE
;
438 FileObject
->WriteAccess
= FALSE
;
439 FileObject
->DeleteAccess
= FALSE
;
440 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
441 FileObject
->FsContext
= Fcb
;
442 FileObject
->FsContext2
= newCCB
;
443 newCCB
->PtrFileObject
= FileObject
;
446 if (CdfsFCBIsDirectory(Fcb
))
448 CcInitializeCacheMap(FileObject
,
449 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
451 &(CdfsGlobalData
->CacheMgrCallbacks
),
453 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
456 DPRINT("file open: fcb:%p file size: %u\n", Fcb
, Fcb
->Entry
.DataLengthL
);
458 return(STATUS_SUCCESS
);
463 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt
,
465 PUNICODE_STRING FileToFind
,
468 UNICODE_STRING TempName
;
477 LARGE_INTEGER StreamOffset
, OffsetOfEntry
;
480 WCHAR ShortNameBuffer
[13];
481 UNICODE_STRING ShortName
;
482 UNICODE_STRING LongName
;
483 UNICODE_STRING FileToFindUpcase
;
486 ASSERT(DirectoryFcb
);
489 DPRINT("CdfsDirFindFile(VCB:%p, dirFCB:%p, File:%wZ)\n",
493 DPRINT("Dir Path:%wZ\n", &DirectoryFcb
->PathName
);
495 /* default to '.' if no filename specified */
496 if (FileToFind
->Length
== 0)
498 RtlInitUnicodeString(&TempName
, L
".");
499 FileToFind
= &TempName
;
502 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
503 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
505 if (!CcMapData(DeviceExt
->StreamFileObject
,
512 DPRINT("CcMapData() failed\n");
513 return STATUS_UNSUCCESSFUL
;
518 Record
= (PDIR_RECORD
)Block
;
520 /* Upper case the expression for FsRtlIsNameInExpression */
521 Status
= RtlUpcaseUnicodeString(&FileToFindUpcase
, FileToFind
, TRUE
);
522 if (!NT_SUCCESS(Status
))
529 if (Record
->RecordLength
== 0)
531 DPRINT("RecordLength == 0 Stopped!\n");
535 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
536 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
538 CdfsGetDirEntryName(DeviceExt
, Record
, Name
);
539 DPRINT ("Name '%S'\n", Name
);
540 DPRINT ("Sector %lu\n", DirectoryFcb
->Entry
.ExtentLocationL
);
541 DPRINT ("Offset %lu\n", Offset
);
543 RtlInitUnicodeString(&LongName
, Name
);
544 ShortName
.Length
= 0;
545 ShortName
.MaximumLength
= 26;
546 ShortName
.Buffer
= ShortNameBuffer
;
547 memset(ShortNameBuffer
, 0, 26);
549 OffsetOfEntry
.QuadPart
= StreamOffset
.QuadPart
+ Offset
;
550 CdfsShortNameCacheGet(DirectoryFcb
, &OffsetOfEntry
, &LongName
, &ShortName
);
552 DPRINT("ShortName '%wZ'\n", &ShortName
);
554 if (FsRtlIsNameInExpression(&FileToFindUpcase
, &LongName
, TRUE
, NULL
) ||
555 FsRtlIsNameInExpression(&FileToFindUpcase
, &ShortName
, TRUE
, NULL
))
557 DPRINT("Match found, %S\n", Name
);
558 Status
= CdfsMakeFCBFromDirEntry(DeviceExt
,
563 DirectoryFcb
->Entry
.ExtentLocationL
,
567 RtlFreeUnicodeString(&FileToFindUpcase
);
568 CcUnpinData(Context
);
573 Offset
+= Record
->RecordLength
;
574 BlockOffset
+= Record
->RecordLength
;
575 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
576 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
578 DPRINT("Map next sector\n");
579 CcUnpinData(Context
);
580 StreamOffset
.QuadPart
+= BLOCKSIZE
;
581 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
584 if (!CcMapData(DeviceExt
->StreamFileObject
,
589 DPRINT("CcMapData() failed\n");
590 RtlFreeUnicodeString(&FileToFindUpcase
);
591 return(STATUS_UNSUCCESSFUL
);
593 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
596 if (Offset
>= DirSize
)
600 RtlFreeUnicodeString(&FileToFindUpcase
);
601 CcUnpinData(Context
);
603 return(STATUS_OBJECT_NAME_NOT_FOUND
);
608 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb
,
611 PUNICODE_STRING FileName
)
613 UNICODE_STRING PathName
;
614 UNICODE_STRING ElementName
;
616 WCHAR pathName
[MAX_PATH
];
617 WCHAR elementName
[MAX_PATH
];
618 PWCHAR currentElement
;
622 DPRINT("CdfsGetFCBForFile(%p, %p, %p, '%wZ')\n",
628 /* Trivial case, open of the root directory on volume */
629 if (FileName
->Buffer
[0] == L
'\0' || wcscmp(FileName
->Buffer
, L
"\\") == 0)
631 DPRINT("returning root FCB\n");
633 FCB
= CdfsOpenRootFCB(Vcb
);
637 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
641 currentElement
= &FileName
->Buffer
[1];
642 wcscpy (pathName
, L
"\\");
643 FCB
= CdfsOpenRootFCB (Vcb
);
647 /* Parse filename and check each path element for existance and access */
648 while (CdfsGetNextPathElement(currentElement
) != 0)
650 /* Skip blank directory levels */
651 if ((CdfsGetNextPathElement(currentElement
) - currentElement
) == 0)
657 DPRINT("Parsing, currentElement:%S\n", currentElement
);
658 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
660 /* Descend to next directory level */
663 CdfsReleaseFCB(Vcb
, parentFCB
);
667 /* fail if element in FCB is not a directory */
668 if (!CdfsFCBIsDirectory(FCB
))
670 DPRINT("Element in requested path is not a directory\n");
672 CdfsReleaseFCB(Vcb
, FCB
);
677 return(STATUS_OBJECT_PATH_NOT_FOUND
);
681 /* Extract next directory level into dirName */
682 CdfsWSubString(pathName
,
684 CdfsGetNextPathElement(currentElement
) - FileName
->Buffer
);
685 DPRINT(" pathName:%S\n", pathName
);
687 RtlInitUnicodeString(&PathName
, pathName
);
689 FCB
= CdfsGrabFCBFromTable(Vcb
, &PathName
);
692 CdfsWSubString(elementName
,
694 CdfsGetNextPathElement(currentElement
) - currentElement
);
695 DPRINT(" elementName:%S\n", elementName
);
697 RtlInitUnicodeString(&ElementName
, elementName
);
698 Status
= CdfsDirFindFile(Vcb
,
702 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
704 *pParentFCB
= parentFCB
;
706 currentElement
= CdfsGetNextPathElement(currentElement
);
707 if (*currentElement
== L
'\0' || CdfsGetNextPathElement(currentElement
+ 1) == 0)
709 return(STATUS_OBJECT_NAME_NOT_FOUND
);
713 return(STATUS_OBJECT_PATH_NOT_FOUND
);
716 else if (!NT_SUCCESS(Status
))
718 CdfsReleaseFCB(Vcb
, parentFCB
);
725 currentElement
= CdfsGetNextPathElement(currentElement
);
728 *pParentFCB
= parentFCB
;
731 return STATUS_SUCCESS
;