3 * Copyright (C) 2002 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
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
19 * COPYRIGHT: See COPYING in the top level directory
20 * PROJECT: ReactOS kernel
21 * FILE: drivers/filesystem/ntfs/fcb.c
22 * PURPOSE: NTFS filesystem driver
23 * PROGRAMMER: Eric Kohl
26 /* INCLUDES *****************************************************************/
33 /* MACROS *******************************************************************/
35 #define TAG_FCB 'BCFI'
37 /* FUNCTIONS ****************************************************************/
41 NtfsGetNextPathElement(PWCHAR FileName
)
43 if (*FileName
== L
'\0')
48 while (*FileName
!= L
'\0' && *FileName
!= L
'\\')
59 NtfsWSubString(PWCHAR pTarget
,
63 wcsncpy(pTarget
, pSource
, pLength
);
64 pTarget
[pLength
] = L
'\0';
69 NtfsCreateFCB(PCWSTR FileName
,
75 ASSERT(Vcb
->Identifier
.Type
== NTFS_TYPE_VCB
);
77 Fcb
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_FCB
), TAG_FCB
);
78 RtlZeroMemory(Fcb
, sizeof(NTFS_FCB
));
80 Fcb
->Identifier
.Type
= NTFS_TYPE_FCB
;
81 Fcb
->Identifier
.Size
= sizeof(NTFS_TYPE_FCB
);
87 wcscpy(Fcb
->PathName
, FileName
);
88 if (wcsrchr(Fcb
->PathName
, '\\') != 0)
90 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
, '\\');
94 Fcb
->ObjectName
= Fcb
->PathName
;
98 ExInitializeResourceLite(&Fcb
->MainResource
);
100 Fcb
->RFCB
.Resource
= &(Fcb
->MainResource
);
107 NtfsDestroyFCB(PNTFS_FCB Fcb
)
110 ASSERT(Fcb
->Identifier
.Type
== NTFS_TYPE_FCB
);
112 ExDeleteResourceLite(&Fcb
->MainResource
);
119 NtfsFCBIsDirectory(PNTFS_FCB Fcb
)
121 UNREFERENCED_PARAMETER(Fcb
);
122 // return(Fcb->entry.Attrib & FILE_ATTRIBUTE_DIRECTORY);
123 // return(Fcb->Entry.FileFlags & 0x02);
129 NtfsFCBIsRoot(PNTFS_FCB Fcb
)
131 return (wcscmp(Fcb
->PathName
, L
"\\") == 0);
136 NtfsGrabFCB(PNTFS_VCB Vcb
,
141 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
146 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
148 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
153 NtfsReleaseFCB(PNTFS_VCB Vcb
,
158 DPRINT("releasing FCB at %p: %S, refCount:%d\n",
163 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
165 if (Fcb
->RefCount
<= 0 && !NtfsFCBIsDirectory(Fcb
))
167 RemoveEntryList(&Fcb
->FcbListEntry
);
168 CcUninitializeCacheMap(Fcb
->FileObject
, NULL
, NULL
);
172 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
177 NtfsAddFCBToTable(PNTFS_VCB Vcb
,
182 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
184 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
185 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
190 NtfsGrabFCBFromTable(PNTFS_VCB Vcb
,
195 PLIST_ENTRY current_entry
;
197 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
199 if (FileName
== NULL
|| *FileName
== 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
, NTFS_FCB
, FcbListEntry
);
213 DPRINT("Comparing '%S' and '%S'\n", FileName
, Fcb
->PathName
);
214 if (_wcsicmp(FileName
, Fcb
->PathName
) == 0)
217 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
221 //FIXME: need to compare against short name in FCB here
223 current_entry
= current_entry
->Flink
;
226 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
233 NtfsFCBInitializeCache(PNTFS_VCB Vcb
,
236 PFILE_OBJECT FileObject
;
240 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
242 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
245 return STATUS_INSUFFICIENT_RESOURCES
;
248 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
250 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
251 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
253 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
254 FileObject
->FsContext
= Fcb
;
255 FileObject
->FsContext2
= newCCB
;
256 newCCB
->PtrFileObject
= FileObject
;
257 Fcb
->FileObject
= FileObject
;
260 Status
= STATUS_SUCCESS
;
261 CcInitializeCacheMap(FileObject
,
262 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
264 &(NtfsGlobalData
->CacheMgrCallbacks
),
267 ObDereferenceObject(FileObject
);
268 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
275 NtfsMakeRootFCB(PNTFS_VCB Vcb
)
279 Fcb
= NtfsCreateFCB(L
"\\", Vcb
);
281 // memset(Fcb->entry.Filename, ' ', 11);
283 // Fcb->Entry.DataLengthL = Vcb->CdInfo.RootSize;
284 // Fcb->Entry.ExtentLocationL = Vcb->CdInfo.RootStart;
285 // Fcb->Entry.FileFlags = 0x02; // FILE_ATTRIBUTE_DIRECTORY;
288 Fcb
->RFCB
.FileSize
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
289 Fcb
->RFCB
.ValidDataLength
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
290 Fcb
->RFCB
.AllocationSize
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
292 NtfsFCBInitializeCache(Vcb
, Fcb
);
293 NtfsAddFCBToTable(Vcb
, Fcb
);
294 NtfsGrabFCB(Vcb
, Fcb
);
301 NtfsOpenRootFCB(PNTFS_VCB Vcb
)
305 Fcb
= NtfsGrabFCBFromTable(Vcb
, L
"\\");
308 Fcb
= NtfsMakeRootFCB(Vcb
);
317 NtfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
321 * FUNCTION: Retrieves the file name, be it in short or long file name format
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
];
344 NtfsSwapString(Name
, Record
->FileId
, Record
->FileIdLength
);
348 DPRINT("Name '%S'\n", Name
);
353 NtfsMakeFCBFromDirEntry(PVCB Vcb
,
359 WCHAR pathName
[MAX_PATH
];
363 if (Name
[0] != 0 && wcslen (DirectoryFCB
->PathName
) +
364 sizeof(WCHAR
) + wcslen (Name
) > MAX_PATH
)
366 return(STATUS_OBJECT_NAME_INVALID
);
369 wcscpy(pathName
, DirectoryFCB
->PathName
);
370 if (!NtfsFCBIsRoot(DirectoryFCB
))
372 wcscat(pathName
, L
"\\");
377 wcscat(pathName
, Name
);
381 WCHAR entryName
[MAX_PATH
];
383 NtfsGetDirEntryName(Vcb
, Record
, entryName
);
384 wcscat(pathName
, entryName
);
387 rcFCB
= NtfsCreateFCB(pathName
, Vcb
);
388 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
390 Size
= rcFCB
->Entry
.DataLengthL
;
392 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
393 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
394 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
395 // DPRINT1("%S %d %d\n", longName, Size, (ULONG)rcFCB->RFCB.AllocationSize.QuadPart);
396 NtfsFCBInitializeCache(Vcb
, rcFCB
);
398 NtfsAddFCBToTable(Vcb
, rcFCB
);
401 return(STATUS_SUCCESS
);
407 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb
,
409 PFILE_OBJECT FileObject
)
413 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
416 return STATUS_INSUFFICIENT_RESOURCES
;
419 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
421 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
422 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
424 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
425 FileObject
->FsContext
= Fcb
;
426 FileObject
->FsContext2
= newCCB
;
427 newCCB
->PtrFileObject
= FileObject
;
430 if (!(Fcb
->Flags
& FCB_CACHE_INITIALIZED
))
432 CcInitializeCacheMap(FileObject
,
433 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
438 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
441 //DPRINT("file open: fcb:%x file size: %d\n", Fcb, Fcb->Entry.DataLengthL);
443 return STATUS_SUCCESS
;
448 NtfsDirFindFile(PNTFS_VCB Vcb
,
449 PNTFS_FCB DirectoryFcb
,
464 LARGE_INTEGER StreamOffset
;
468 ASSERT(DirectoryFcb
);
471 DPRINT("NtfsDirFindFile(VCB:%08x, dirFCB:%08x, File:%S)\n",
475 DPRINT("Dir Path:%S\n", DirectoryFcb
->PathName
);
477 /* default to '.' if no filename specified */
478 if (wcslen(FileToFind
) == 0)
482 FileToFind
= TempName
;
485 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
486 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
488 if(!CcMapData(DeviceExt
->StreamFileObject
, &StreamOffset
,
489 BLOCKSIZE
, TRUE
, &Context
, &Block
))
491 DPRINT("CcMapData() failed\n");
492 return(STATUS_UNSUCCESSFUL
);
497 Record
= (PDIR_RECORD
)Block
;
500 if (Record
->RecordLength
== 0)
502 DPRINT("RecordLength == 0 Stopped!\n");
506 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
507 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
509 NtfsGetDirEntryName(DeviceExt
, Record
, Name
);
510 DPRINT("Name '%S'\n", Name
);
512 if (wstrcmpjoki(Name
, FileToFind
))
514 DPRINT("Match found, %S\n", Name
);
515 Status
= NtfsMakeFCBFromDirEntry(DeviceExt
,
521 CcUnpinData(Context
);
526 Offset
+= Record
->RecordLength
;
527 BlockOffset
+= Record
->RecordLength
;
528 Record
= (PDIR_RECORD
)(Block
+ BlockOffset
);
529 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
531 DPRINT("Map next sector\n");
532 CcUnpinData(Context
);
533 StreamOffset
.QuadPart
+= BLOCKSIZE
;
534 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
537 if (!CcMapData(DeviceExt
->StreamFileObject
,
542 DPRINT("CcMapData() failed\n");
543 return(STATUS_UNSUCCESSFUL
);
545 Record
= (PDIR_RECORD
)(Block
+ BlockOffset
);
548 if (Offset
>= DirSize
)
552 CcUnpinData(Context
);
554 UNREFERENCED_PARAMETER(Vcb
);
555 UNREFERENCED_PARAMETER(DirectoryFcb
);
556 UNREFERENCED_PARAMETER(FileToFind
);
557 UNREFERENCED_PARAMETER(FoundFCB
);
559 return STATUS_OBJECT_NAME_NOT_FOUND
;
564 NtfsGetFCBForFile(PNTFS_VCB Vcb
,
565 PNTFS_FCB
*pParentFCB
,
567 const PWSTR pFileName
)
570 WCHAR pathName
[MAX_PATH
];
571 WCHAR elementName
[MAX_PATH
];
572 PWCHAR currentElement
;
576 DPRINT("NtfsGetFCBForFile(%p, %p, %p, '%S')\n",
583 // FCB = NtfsOpenRootFCB(Vcb);
585 // *pParentFCB = NULL;
588 /* Trivial case, open of the root directory on volume */
589 if (pFileName
[0] == L
'\0' || wcscmp(pFileName
, L
"\\") == 0)
591 DPRINT("returning root FCB\n");
593 FCB
= NtfsOpenRootFCB(Vcb
);
597 return (FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
;
601 currentElement
= pFileName
+ 1;
602 wcscpy (pathName
, L
"\\");
603 FCB
= NtfsOpenRootFCB (Vcb
);
608 /* Parse filename and check each path element for existance and access */
609 while (NtfsGetNextPathElement(currentElement
) != 0)
611 /* Skip blank directory levels */
612 if ((NtfsGetNextPathElement(currentElement
) - currentElement
) == 0)
618 DPRINT("Parsing, currentElement:%S\n", currentElement
);
619 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
621 /* Descend to next directory level */
624 NtfsReleaseFCB(Vcb
, parentFCB
);
628 /* fail if element in FCB is not a directory */
629 if (!NtfsFCBIsDirectory(FCB
))
631 DPRINT("Element in requested path is not a directory\n");
633 NtfsReleaseFCB(Vcb
, FCB
);
638 return STATUS_OBJECT_PATH_NOT_FOUND
;
643 /* Extract next directory level into dirName */
644 NtfsWSubString(pathName
,
646 NtfsGetNextPathElement(currentElement
) - pFileName
);
647 DPRINT(" pathName:%S\n", pathName
);
649 FCB
= NtfsGrabFCBFromTable(Vcb
, pathName
);
652 NtfsWSubString(elementName
,
654 NtfsGetNextPathElement(currentElement
) - currentElement
);
655 DPRINT(" elementName:%S\n", elementName
);
657 Status
= NtfsDirFindFile(Vcb
, parentFCB
, elementName
, &FCB
);
658 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
660 *pParentFCB
= parentFCB
;
662 currentElement
= NtfsGetNextPathElement(currentElement
);
663 if (*currentElement
== L
'\0' || NtfsGetNextPathElement(currentElement
+ 1) == 0)
665 return STATUS_OBJECT_NAME_NOT_FOUND
;
669 return STATUS_OBJECT_PATH_NOT_FOUND
;
672 else if (!NT_SUCCESS(Status
))
674 NtfsReleaseFCB(Vcb
, parentFCB
);
682 currentElement
= NtfsGetNextPathElement(currentElement
);
685 *pParentFCB
= parentFCB
;
689 return STATUS_SUCCESS
;