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
));
79 CdfsWSubString(Fcb
->PathName
, FileName
, sizeof(Fcb
->PathName
) / sizeof(Fcb
->PathName
[0]) - 1);
80 if (wcsrchr(Fcb
->PathName
, '\\') != 0)
82 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
, '\\');
86 Fcb
->ObjectName
= Fcb
->PathName
;
90 ExInitializeResourceLite(&Fcb
->PagingIoResource
);
91 ExInitializeResourceLite(&Fcb
->MainResource
);
92 ExInitializeResourceLite(&Fcb
->NameListResource
);
93 Fcb
->RFCB
.PagingIoResource
= &Fcb
->PagingIoResource
;
94 Fcb
->RFCB
.Resource
= &Fcb
->MainResource
;
95 Fcb
->RFCB
.IsFastIoPossible
= FastIoIsNotPossible
;
96 InitializeListHead(&Fcb
->ShortNameList
);
103 CdfsDestroyFCB(PFCB Fcb
)
107 ExDeleteResourceLite(&Fcb
->PagingIoResource
);
108 ExDeleteResourceLite(&Fcb
->MainResource
);
110 while (!IsListEmpty(&Fcb
->ShortNameList
))
112 Entry
= Fcb
->ShortNameList
.Flink
;
113 RemoveEntryList(Entry
);
114 ExFreePoolWithTag(Entry
, TAG_FCB
);
117 ExDeleteResourceLite(&Fcb
->NameListResource
);
118 ExFreePoolWithTag(Fcb
, TAG_FCB
);
123 CdfsFCBIsDirectory(PFCB Fcb
)
125 return(Fcb
->Entry
.FileFlags
& FILE_FLAG_DIRECTORY
);
130 CdfsFCBIsRoot(PFCB Fcb
)
132 return(wcscmp(Fcb
->PathName
, L
"\\") == 0);
137 CdfsGrabFCB(PDEVICE_EXTENSION Vcb
,
142 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
147 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
149 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
154 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb
,
159 DPRINT("releasing FCB at %p: %S, refCount:%d\n",
164 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
166 if (Fcb
->RefCount
<= 0 && !CdfsFCBIsDirectory(Fcb
))
168 RemoveEntryList(&Fcb
->FcbListEntry
);
171 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
176 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb
,
181 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
183 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
184 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
189 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb
,
190 PUNICODE_STRING FileName
)
194 PLIST_ENTRY current_entry
;
196 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
198 if (FileName
== NULL
|| FileName
->Length
== 0 || FileName
->Buffer
[0] == 0)
200 DPRINT("Return FCB for stream file object\n");
201 Fcb
= Vcb
->StreamFileObject
->FsContext
;
203 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
207 current_entry
= Vcb
->FcbListHead
.Flink
;
208 while (current_entry
!= &Vcb
->FcbListHead
)
210 Fcb
= CONTAINING_RECORD(current_entry
, FCB
, FcbListEntry
);
212 DPRINT("Comparing '%wZ' and '%S'\n", FileName
, Fcb
->PathName
);
213 if (_wcsicmp(FileName
->Buffer
, Fcb
->PathName
) == 0)
216 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
220 //FIXME: need to compare against short name in FCB here
222 current_entry
= current_entry
->Flink
;
224 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
231 CdfsFCBInitializeCache(PVCB Vcb
,
234 PFILE_OBJECT FileObject
;
237 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
239 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
242 return STATUS_INSUFFICIENT_RESOURCES
;
244 RtlZeroMemory(newCCB
,
247 FileObject
->ReadAccess
= TRUE
;
248 FileObject
->WriteAccess
= FALSE
;
249 FileObject
->DeleteAccess
= FALSE
;
250 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
251 FileObject
->FsContext
= Fcb
;
252 FileObject
->FsContext2
= newCCB
;
253 newCCB
->PtrFileObject
= FileObject
;
254 Fcb
->FileObject
= FileObject
;
257 CcInitializeCacheMap(FileObject
,
258 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
260 &(CdfsGlobalData
->CacheMgrCallbacks
),
263 ObDereferenceObject(FileObject
);
264 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
266 return STATUS_SUCCESS
;
271 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb
)
275 Fcb
= CdfsCreateFCB(L
"\\");
277 Fcb
->Entry
.DataLengthL
= Vcb
->CdInfo
.RootSize
;
278 Fcb
->Entry
.ExtentLocationL
= Vcb
->CdInfo
.RootStart
;
279 Fcb
->Entry
.FileFlags
= FILE_FLAG_DIRECTORY
;
280 Fcb
->IndexNumber
.QuadPart
= 0LL;
283 Fcb
->RFCB
.FileSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
284 Fcb
->RFCB
.ValidDataLength
.QuadPart
= Vcb
->CdInfo
.RootSize
;
285 Fcb
->RFCB
.AllocationSize
.QuadPart
= Vcb
->CdInfo
.RootSize
;
287 CdfsFCBInitializeCache(Vcb
, Fcb
);
288 CdfsAddFCBToTable(Vcb
, Fcb
);
289 CdfsGrabFCB(Vcb
, Fcb
);
296 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb
)
298 UNICODE_STRING FileName
;
301 RtlInitUnicodeString(&FileName
, L
"\\");
303 Fcb
= CdfsGrabFCBFromTable(Vcb
,
307 Fcb
= CdfsMakeRootFCB(Vcb
);
315 CdfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
319 * FUNCTION: Retrieves the file name from a directory record.
322 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
326 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
332 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
336 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
337 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
344 Record
->FileIdLength
);
348 DPRINT("Name '%S'\n", Name
);
353 CdfsMakeFCBFromDirEntry(PVCB Vcb
,
358 ULONG DirectorySector
,
359 ULONG DirectoryOffset
,
362 WCHAR pathName
[MAX_PATH
];
366 /* Check if the full string would overflow the pathName buffer (the additional characters are for '\\' and '\0') */
367 if ((LongName
[0] != 0) &&
368 (wcslen(DirectoryFCB
->PathName
) + 1 + wcslen(LongName
) + 1 > MAX_PATH
))
370 return(STATUS_OBJECT_NAME_INVALID
);
373 wcscpy(pathName
, DirectoryFCB
->PathName
);
374 if (!CdfsFCBIsRoot(DirectoryFCB
))
376 wcscat(pathName
, L
"\\");
379 if (LongName
[0] != 0)
381 wcscat(pathName
, LongName
);
385 WCHAR entryName
[MAX_PATH
];
387 CdfsGetDirEntryName(Vcb
, Record
, entryName
);
388 wcscat(pathName
, entryName
);
391 rcFCB
= CdfsCreateFCB(pathName
);
392 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
394 /* Copy short name into FCB */
395 rcFCB
->ShortNameU
.Length
= wcslen(ShortName
) * sizeof(WCHAR
);
396 rcFCB
->ShortNameU
.MaximumLength
= rcFCB
->ShortNameU
.Length
;
397 rcFCB
->ShortNameU
.Buffer
= rcFCB
->ShortNameBuffer
;
398 wcscpy(rcFCB
->ShortNameBuffer
, ShortName
);
400 Size
= rcFCB
->Entry
.DataLengthL
;
402 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
403 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
404 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
405 if (CdfsFCBIsDirectory(rcFCB
))
407 CdfsFCBInitializeCache(Vcb
, rcFCB
);
409 rcFCB
->IndexNumber
.u
.HighPart
= DirectorySector
;
410 rcFCB
->IndexNumber
.u
.LowPart
= DirectoryOffset
;
412 CdfsAddFCBToTable(Vcb
, rcFCB
);
415 DPRINT("%S %u %I64d\n", LongName
, Size
, rcFCB
->RFCB
.AllocationSize
.QuadPart
);
417 return(STATUS_SUCCESS
);
422 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb
,
424 PFILE_OBJECT FileObject
)
428 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(CCB
), TAG_CCB
);
431 return(STATUS_INSUFFICIENT_RESOURCES
);
433 memset(newCCB
, 0, sizeof(CCB
));
435 FileObject
->ReadAccess
= TRUE
;
436 FileObject
->WriteAccess
= FALSE
;
437 FileObject
->DeleteAccess
= FALSE
;
438 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
439 FileObject
->FsContext
= Fcb
;
440 FileObject
->FsContext2
= newCCB
;
441 newCCB
->PtrFileObject
= FileObject
;
444 if (CdfsFCBIsDirectory(Fcb
))
446 CcInitializeCacheMap(FileObject
,
447 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
449 &(CdfsGlobalData
->CacheMgrCallbacks
),
451 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
454 DPRINT("file open: fcb:%p file size: %u\n", Fcb
, Fcb
->Entry
.DataLengthL
);
456 return(STATUS_SUCCESS
);
461 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt
,
463 PUNICODE_STRING FileToFind
,
466 UNICODE_STRING TempName
;
475 LARGE_INTEGER StreamOffset
, OffsetOfEntry
;
478 WCHAR ShortNameBuffer
[13];
479 UNICODE_STRING ShortName
;
480 UNICODE_STRING LongName
;
481 UNICODE_STRING FileToFindUpcase
;
484 ASSERT(DirectoryFcb
);
487 DPRINT("CdfsDirFindFile(VCB:%p, dirFCB:%p, File:%wZ)\n",
491 DPRINT("Dir Path:%S\n", DirectoryFcb
->PathName
);
493 /* default to '.' if no filename specified */
494 if (FileToFind
->Length
== 0)
496 RtlInitUnicodeString(&TempName
, L
".");
497 FileToFind
= &TempName
;
500 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
501 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
503 if (!CcMapData(DeviceExt
->StreamFileObject
,
510 DPRINT("CcMapData() failed\n");
511 return STATUS_UNSUCCESSFUL
;
516 Record
= (PDIR_RECORD
)Block
;
518 /* Upper case the expression for FsRtlIsNameInExpression */
519 Status
= RtlUpcaseUnicodeString(&FileToFindUpcase
, FileToFind
, TRUE
);
520 if (!NT_SUCCESS(Status
))
527 if (Record
->RecordLength
== 0)
529 DPRINT("RecordLength == 0 Stopped!\n");
533 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
534 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
536 CdfsGetDirEntryName(DeviceExt
, Record
, Name
);
537 DPRINT ("Name '%S'\n", Name
);
538 DPRINT ("Sector %lu\n", DirectoryFcb
->Entry
.ExtentLocationL
);
539 DPRINT ("Offset %lu\n", Offset
);
541 RtlInitUnicodeString(&LongName
, Name
);
542 ShortName
.Length
= 0;
543 ShortName
.MaximumLength
= 26;
544 ShortName
.Buffer
= ShortNameBuffer
;
545 memset(ShortNameBuffer
, 0, 26);
547 OffsetOfEntry
.QuadPart
= StreamOffset
.QuadPart
+ Offset
;
548 CdfsShortNameCacheGet(DirectoryFcb
, &OffsetOfEntry
, &LongName
, &ShortName
);
550 DPRINT("ShortName '%wZ'\n", &ShortName
);
552 if (FsRtlIsNameInExpression(&FileToFindUpcase
, &LongName
, TRUE
, NULL
) ||
553 FsRtlIsNameInExpression(&FileToFindUpcase
, &ShortName
, TRUE
, NULL
))
555 DPRINT("Match found, %S\n", Name
);
556 Status
= CdfsMakeFCBFromDirEntry(DeviceExt
,
561 DirectoryFcb
->Entry
.ExtentLocationL
,
565 RtlFreeUnicodeString(&FileToFindUpcase
);
566 CcUnpinData(Context
);
571 Offset
+= Record
->RecordLength
;
572 BlockOffset
+= Record
->RecordLength
;
573 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
574 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
576 DPRINT("Map next sector\n");
577 CcUnpinData(Context
);
578 StreamOffset
.QuadPart
+= BLOCKSIZE
;
579 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
582 if (!CcMapData(DeviceExt
->StreamFileObject
,
587 DPRINT("CcMapData() failed\n");
588 RtlFreeUnicodeString(&FileToFindUpcase
);
589 return(STATUS_UNSUCCESSFUL
);
591 Record
= (PDIR_RECORD
)((ULONG_PTR
)Block
+ BlockOffset
);
594 if (Offset
>= DirSize
)
598 RtlFreeUnicodeString(&FileToFindUpcase
);
599 CcUnpinData(Context
);
601 return(STATUS_OBJECT_NAME_NOT_FOUND
);
606 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb
,
609 PUNICODE_STRING FileName
)
611 UNICODE_STRING PathName
;
612 UNICODE_STRING ElementName
;
614 WCHAR pathName
[MAX_PATH
];
615 WCHAR elementName
[MAX_PATH
];
616 PWCHAR currentElement
;
620 DPRINT("CdfsGetFCBForFile(%p, %p, %p, '%wZ')\n",
626 /* Trivial case, open of the root directory on volume */
627 if (FileName
->Buffer
[0] == L
'\0' || wcscmp(FileName
->Buffer
, L
"\\") == 0)
629 DPRINT("returning root FCB\n");
631 FCB
= CdfsOpenRootFCB(Vcb
);
635 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
639 currentElement
= &FileName
->Buffer
[1];
640 wcscpy (pathName
, L
"\\");
641 FCB
= CdfsOpenRootFCB (Vcb
);
645 /* Parse filename and check each path element for existance and access */
646 while (CdfsGetNextPathElement(currentElement
) != 0)
648 /* Skip blank directory levels */
649 if ((CdfsGetNextPathElement(currentElement
) - currentElement
) == 0)
655 DPRINT("Parsing, currentElement:%S\n", currentElement
);
656 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
658 /* Descend to next directory level */
661 CdfsReleaseFCB(Vcb
, parentFCB
);
665 /* fail if element in FCB is not a directory */
666 if (!CdfsFCBIsDirectory(FCB
))
668 DPRINT("Element in requested path is not a directory\n");
670 CdfsReleaseFCB(Vcb
, FCB
);
675 return(STATUS_OBJECT_PATH_NOT_FOUND
);
679 /* Extract next directory level into dirName */
680 CdfsWSubString(pathName
,
682 CdfsGetNextPathElement(currentElement
) - FileName
->Buffer
);
683 DPRINT(" pathName:%S\n", pathName
);
685 RtlInitUnicodeString(&PathName
, pathName
);
687 FCB
= CdfsGrabFCBFromTable(Vcb
, &PathName
);
690 CdfsWSubString(elementName
,
692 CdfsGetNextPathElement(currentElement
) - currentElement
);
693 DPRINT(" elementName:%S\n", elementName
);
695 RtlInitUnicodeString(&ElementName
, elementName
);
696 Status
= CdfsDirFindFile(Vcb
,
700 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
702 *pParentFCB
= parentFCB
;
704 currentElement
= CdfsGetNextPathElement(currentElement
);
705 if (*currentElement
== L
'\0' || CdfsGetNextPathElement(currentElement
+ 1) == 0)
707 return(STATUS_OBJECT_NAME_NOT_FOUND
);
711 return(STATUS_OBJECT_PATH_NOT_FOUND
);
714 else if (!NT_SUCCESS(Status
))
716 CdfsReleaseFCB(Vcb
, parentFCB
);
723 currentElement
= CdfsGetNextPathElement(currentElement
);
726 *pParentFCB
= parentFCB
;
729 return STATUS_SUCCESS
;