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 /* GLOBALS *****************************************************************/
37 /* MACROS *******************************************************************/
39 #define TAG_FCB TAG('I', 'F', 'C', 'B')
43 /* FUNCTIONS ****************************************************************/
46 NtfsGetNextPathElement(PWCHAR FileName
)
48 if (*FileName
== L
'\0')
53 while (*FileName
!= L
'\0' && *FileName
!= L
'\\')
63 NtfsWSubString(PWCHAR pTarget
, const PWCHAR pSource
, size_t pLength
)
65 wcsncpy (pTarget
, pSource
, pLength
);
66 pTarget
[pLength
] = L
'\0';
71 NtfsCreateFCB(PCWSTR FileName
, PNTFS_VCB Vcb
)
76 ASSERT(Vcb
->Identifier
.Type
== NTFS_TYPE_VCB
);
78 Fcb
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_FCB
), TAG_FCB
);
79 RtlZeroMemory(Fcb
, sizeof(NTFS_FCB
));
81 Fcb
->Identifier
.Type
= NTFS_TYPE_FCB
;
82 Fcb
->Identifier
.Size
= sizeof(NTFS_TYPE_FCB
);
88 wcscpy(Fcb
->PathName
, FileName
);
89 if (wcsrchr(Fcb
->PathName
, '\\') != 0)
91 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
, '\\');
95 Fcb
->ObjectName
= Fcb
->PathName
;
99 ExInitializeResourceLite(&Fcb
->MainResource
);
101 Fcb
->RFCB
.Resource
= &(Fcb
->MainResource
);
108 NtfsDestroyFCB(PNTFS_FCB Fcb
)
111 ASSERT(Fcb
->Identifier
.Type
== NTFS_TYPE_FCB
);
113 ExDeleteResourceLite(&Fcb
->MainResource
);
120 NtfsFCBIsDirectory(PNTFS_FCB 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
);
171 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
176 NtfsAddFCBToTable(PNTFS_VCB Vcb
,
181 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
183 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
184 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
189 NtfsGrabFCBFromTable(PNTFS_VCB Vcb
,
194 PLIST_ENTRY current_entry
;
196 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
198 if (FileName
== NULL
|| *FileName
== 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
, NTFS_FCB
, FcbListEntry
);
212 DPRINT("Comparing '%S' and '%S'\n", FileName
, Fcb
->PathName
);
213 if (_wcsicmp(FileName
, 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 NtfsFCBInitializeCache(PNTFS_VCB Vcb
,
234 PFILE_OBJECT FileObject
;
238 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
240 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
243 return(STATUS_INSUFFICIENT_RESOURCES
);
245 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
247 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
248 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
250 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
251 FileObject
->FsContext
= Fcb
;
252 FileObject
->FsContext2
= newCCB
;
253 newCCB
->PtrFileObject
= FileObject
;
254 Fcb
->FileObject
= FileObject
;
257 Status
= STATUS_SUCCESS
;
258 CcInitializeCacheMap(FileObject
,
259 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
261 &(NtfsGlobalData
->CacheMgrCallbacks
),
264 ObDereferenceObject(FileObject
);
265 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
272 NtfsMakeRootFCB(PNTFS_VCB Vcb
)
276 Fcb
= NtfsCreateFCB(L
"\\", Vcb
);
278 // memset(Fcb->entry.Filename, ' ', 11);
280 // Fcb->Entry.DataLengthL = Vcb->CdInfo.RootSize;
281 // Fcb->Entry.ExtentLocationL = Vcb->CdInfo.RootStart;
282 // Fcb->Entry.FileFlags = 0x02; // FILE_ATTRIBUTE_DIRECTORY;
285 Fcb
->RFCB
.FileSize
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
286 Fcb
->RFCB
.ValidDataLength
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
287 Fcb
->RFCB
.AllocationSize
.QuadPart
= PAGE_SIZE
;//Vcb->CdInfo.RootSize;
289 NtfsFCBInitializeCache(Vcb
, Fcb
);
290 NtfsAddFCBToTable(Vcb
, Fcb
);
291 NtfsGrabFCB(Vcb
, Fcb
);
298 NtfsOpenRootFCB(PNTFS_VCB Vcb
)
302 Fcb
= NtfsGrabFCBFromTable(Vcb
, L
"\\");
305 Fcb
= NtfsMakeRootFCB(Vcb
);
314 NtfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
318 * FUNCTION: Retrieves the file name, be it in short or long file name format
321 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
325 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
331 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
335 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
336 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
341 NtfsSwapString(Name
, Record
->FileId
, Record
->FileIdLength
);
345 DPRINT("Name '%S'\n", Name
);
350 NtfsMakeFCBFromDirEntry(PVCB Vcb
,
356 WCHAR pathName
[MAX_PATH
];
360 if (Name
[0] != 0 && wcslen (DirectoryFCB
->PathName
) +
361 sizeof(WCHAR
) + wcslen (Name
) > MAX_PATH
)
363 return(STATUS_OBJECT_NAME_INVALID
);
366 wcscpy(pathName
, DirectoryFCB
->PathName
);
367 if (!NtfsFCBIsRoot(DirectoryFCB
))
369 wcscat(pathName
, L
"\\");
374 wcscat(pathName
, Name
);
378 WCHAR entryName
[MAX_PATH
];
380 NtfsGetDirEntryName(Vcb
, Record
, entryName
);
381 wcscat(pathName
, entryName
);
384 rcFCB
= NtfsCreateFCB(pathName
, Vcb
);
385 memcpy(&rcFCB
->Entry
, Record
, sizeof(DIR_RECORD
));
387 Size
= rcFCB
->Entry
.DataLengthL
;
389 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
390 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
391 rcFCB
->RFCB
.AllocationSize
.QuadPart
= ROUND_UP(Size
, BLOCKSIZE
);
392 // DPRINT1("%S %d %d\n", longName, Size, (ULONG)rcFCB->RFCB.AllocationSize.QuadPart);
393 NtfsFCBInitializeCache(Vcb
, rcFCB
);
395 NtfsAddFCBToTable(Vcb
, rcFCB
);
398 return(STATUS_SUCCESS
);
404 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb
,
406 PFILE_OBJECT FileObject
)
410 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
413 return(STATUS_INSUFFICIENT_RESOURCES
);
415 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
417 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
418 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
420 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
421 FileObject
->FsContext
= Fcb
;
422 FileObject
->FsContext2
= newCCB
;
423 newCCB
->PtrFileObject
= FileObject
;
426 if (!(Fcb
->Flags
& FCB_CACHE_INITIALIZED
))
428 CcInitializeCacheMap(FileObject
,
429 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
434 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
437 //DPRINT("file open: fcb:%x file size: %d\n", Fcb, Fcb->Entry.DataLengthL);
439 return(STATUS_SUCCESS
);
444 NtfsDirFindFile(PNTFS_VCB Vcb
,
445 PNTFS_FCB DirectoryFcb
,
460 LARGE_INTEGER StreamOffset
;
464 ASSERT(DirectoryFcb
);
467 DPRINT("NtfsDirFindFile(VCB:%08x, dirFCB:%08x, File:%S)\n",
471 DPRINT("Dir Path:%S\n", DirectoryFcb
->PathName
);
473 /* default to '.' if no filename specified */
474 if (wcslen(FileToFind
) == 0)
478 FileToFind
= TempName
;
481 DirSize
= DirectoryFcb
->Entry
.DataLengthL
;
482 StreamOffset
.QuadPart
= (LONGLONG
)DirectoryFcb
->Entry
.ExtentLocationL
* (LONGLONG
)BLOCKSIZE
;
484 if(!CcMapData(DeviceExt
->StreamFileObject
, &StreamOffset
,
485 BLOCKSIZE
, TRUE
, &Context
, &Block
))
487 DPRINT("CcMapData() failed\n");
488 return(STATUS_UNSUCCESSFUL
);
493 Record
= (PDIR_RECORD
)Block
;
496 if (Record
->RecordLength
== 0)
498 DPRINT("RecordLength == 0 Stopped!\n");
502 DPRINT("RecordLength %u ExtAttrRecordLength %u NameLength %u\n",
503 Record
->RecordLength
, Record
->ExtAttrRecordLength
, Record
->FileIdLength
);
505 NtfsGetDirEntryName(DeviceExt
, Record
, Name
);
506 DPRINT("Name '%S'\n", Name
);
508 if (wstrcmpjoki(Name
, FileToFind
))
510 DPRINT("Match found, %S\n", Name
);
511 Status
= NtfsMakeFCBFromDirEntry(DeviceExt
,
517 CcUnpinData(Context
);
522 Offset
+= Record
->RecordLength
;
523 BlockOffset
+= Record
->RecordLength
;
524 Record
= (PDIR_RECORD
)(Block
+ BlockOffset
);
525 if (BlockOffset
>= BLOCKSIZE
|| Record
->RecordLength
== 0)
527 DPRINT("Map next sector\n");
528 CcUnpinData(Context
);
529 StreamOffset
.QuadPart
+= BLOCKSIZE
;
530 Offset
= ROUND_UP(Offset
, BLOCKSIZE
);
533 if (!CcMapData(DeviceExt
->StreamFileObject
,
538 DPRINT("CcMapData() failed\n");
539 return(STATUS_UNSUCCESSFUL
);
541 Record
= (PDIR_RECORD
)(Block
+ BlockOffset
);
544 if (Offset
>= DirSize
)
548 CcUnpinData(Context
);
550 return(STATUS_OBJECT_NAME_NOT_FOUND
);
555 NtfsGetFCBForFile(PNTFS_VCB Vcb
,
556 PNTFS_FCB
*pParentFCB
,
558 const PWSTR pFileName
)
561 WCHAR pathName
[MAX_PATH
];
562 WCHAR elementName
[MAX_PATH
];
563 PWCHAR currentElement
;
567 DPRINT("NtfsGetFCBForFile(%p, %p, %p, '%S')\n",
574 // FCB = NtfsOpenRootFCB(Vcb);
576 // *pParentFCB = NULL;
579 /* Trivial case, open of the root directory on volume */
580 if (pFileName
[0] == L
'\0' || wcscmp(pFileName
, L
"\\") == 0)
582 DPRINT("returning root FCB\n");
584 FCB
= NtfsOpenRootFCB(Vcb
);
588 return((FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
);
592 currentElement
= pFileName
+ 1;
593 wcscpy (pathName
, L
"\\");
594 FCB
= NtfsOpenRootFCB (Vcb
);
598 /* Parse filename and check each path element for existance and access */
599 while (NtfsGetNextPathElement(currentElement
) != 0)
601 /* Skip blank directory levels */
602 if ((NtfsGetNextPathElement(currentElement
) - currentElement
) == 0)
608 DPRINT("Parsing, currentElement:%S\n", currentElement
);
609 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
611 /* Descend to next directory level */
614 NtfsReleaseFCB(Vcb
, parentFCB
);
618 /* fail if element in FCB is not a directory */
619 if (!NtfsFCBIsDirectory(FCB
))
621 DPRINT("Element in requested path is not a directory\n");
623 NtfsReleaseFCB(Vcb
, FCB
);
628 return(STATUS_OBJECT_PATH_NOT_FOUND
);
632 /* Extract next directory level into dirName */
633 NtfsWSubString(pathName
,
635 NtfsGetNextPathElement(currentElement
) - pFileName
);
636 DPRINT(" pathName:%S\n", pathName
);
638 FCB
= NtfsGrabFCBFromTable(Vcb
, pathName
);
641 NtfsWSubString(elementName
,
643 NtfsGetNextPathElement(currentElement
) - currentElement
);
644 DPRINT(" elementName:%S\n", elementName
);
646 Status
= NtfsDirFindFile(Vcb
, parentFCB
, elementName
, &FCB
);
647 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
649 *pParentFCB
= parentFCB
;
651 currentElement
= NtfsGetNextPathElement(currentElement
);
652 if (*currentElement
== L
'\0' || NtfsGetNextPathElement(currentElement
+ 1) == 0)
654 return(STATUS_OBJECT_NAME_NOT_FOUND
);
658 return(STATUS_OBJECT_PATH_NOT_FOUND
);
661 else if (!NT_SUCCESS(Status
))
663 NtfsReleaseFCB(Vcb
, parentFCB
);
670 currentElement
= NtfsGetNextPathElement(currentElement
);
673 *pParentFCB
= parentFCB
;
677 return(STATUS_SUCCESS
);