3 * Copyright (C) 2002, 2014 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 * PROGRAMMERS: Eric Kohl
24 * Pierre Schweitzer (pierre@reactos.org)
25 * Hervé Poussineau (hpoussin@reactos.org)
28 /* INCLUDES *****************************************************************/
35 /* FUNCTIONS ****************************************************************/
39 NtfsGetNextPathElement(PWCHAR FileName
)
41 if (*FileName
== L
'\0')
46 while (*FileName
!= L
'\0' && *FileName
!= L
'\\')
57 NtfsWSubString(PWCHAR pTarget
,
61 wcsncpy(pTarget
, pSource
, pLength
);
62 pTarget
[pLength
] = L
'\0';
67 NtfsCreateFCB(PCWSTR FileName
,
74 ASSERT(Vcb
->Identifier
.Type
== NTFS_TYPE_VCB
);
76 Fcb
= ExAllocateFromNPagedLookasideList(&NtfsGlobalData
->FcbLookasideList
);
77 RtlZeroMemory(Fcb
, sizeof(NTFS_FCB
));
79 Fcb
->Identifier
.Type
= NTFS_TYPE_FCB
;
80 Fcb
->Identifier
.Size
= sizeof(NTFS_TYPE_FCB
);
86 wcscpy(Fcb
->PathName
, FileName
);
87 if (wcsrchr(Fcb
->PathName
, '\\') != 0)
89 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
, '\\');
93 Fcb
->ObjectName
= Fcb
->PathName
;
99 wcscpy(Fcb
->Stream
, Stream
);
103 Fcb
->Stream
[0] = UNICODE_NULL
;
106 ExInitializeResourceLite(&Fcb
->MainResource
);
108 Fcb
->RFCB
.Resource
= &(Fcb
->MainResource
);
115 NtfsDestroyFCB(PNTFS_FCB Fcb
)
118 ASSERT(Fcb
->Identifier
.Type
== NTFS_TYPE_FCB
);
120 ExDeleteResourceLite(&Fcb
->MainResource
);
122 ExFreeToNPagedLookasideList(&NtfsGlobalData
->FcbLookasideList
, Fcb
);
127 NtfsFCBIsDirectory(PNTFS_FCB Fcb
)
129 return ((Fcb
->Entry
.FileAttributes
& NTFS_FILE_TYPE_DIRECTORY
) == NTFS_FILE_TYPE_DIRECTORY
);
134 NtfsFCBIsReparsePoint(PNTFS_FCB Fcb
)
136 return ((Fcb
->Entry
.FileAttributes
& NTFS_FILE_TYPE_REPARSE
) == NTFS_FILE_TYPE_REPARSE
);
141 NtfsFCBIsCompressed(PNTFS_FCB Fcb
)
143 return ((Fcb
->Entry
.FileAttributes
& NTFS_FILE_TYPE_COMPRESSED
) == NTFS_FILE_TYPE_COMPRESSED
);
147 NtfsFCBIsRoot(PNTFS_FCB Fcb
)
149 return (wcscmp(Fcb
->PathName
, L
"\\") == 0);
154 NtfsGrabFCB(PNTFS_VCB Vcb
,
159 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
164 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
166 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
171 NtfsReleaseFCB(PNTFS_VCB Vcb
,
176 DPRINT("releasing FCB at %p: %S, refCount:%d\n",
181 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
183 if (Fcb
->RefCount
<= 0 && !NtfsFCBIsDirectory(Fcb
))
185 RemoveEntryList(&Fcb
->FcbListEntry
);
186 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
187 CcUninitializeCacheMap(Fcb
->FileObject
, NULL
, NULL
);
192 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
198 NtfsAddFCBToTable(PNTFS_VCB Vcb
,
203 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
205 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
206 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
211 NtfsGrabFCBFromTable(PNTFS_VCB Vcb
,
216 PLIST_ENTRY current_entry
;
218 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
220 if (FileName
== NULL
|| *FileName
== 0)
222 DPRINT("Return FCB for stream file object\n");
223 Fcb
= Vcb
->StreamFileObject
->FsContext
;
225 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
229 current_entry
= Vcb
->FcbListHead
.Flink
;
230 while (current_entry
!= &Vcb
->FcbListHead
)
232 Fcb
= CONTAINING_RECORD(current_entry
, NTFS_FCB
, FcbListEntry
);
234 DPRINT("Comparing '%S' and '%S'\n", FileName
, Fcb
->PathName
);
235 if (_wcsicmp(FileName
, Fcb
->PathName
) == 0)
238 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
242 //FIXME: need to compare against short name in FCB here
244 current_entry
= current_entry
->Flink
;
247 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
254 NtfsFCBInitializeCache(PNTFS_VCB Vcb
,
257 PFILE_OBJECT FileObject
;
261 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
263 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
266 return STATUS_INSUFFICIENT_RESOURCES
;
269 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
271 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
272 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
274 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
275 FileObject
->FsContext
= Fcb
;
276 FileObject
->FsContext2
= newCCB
;
277 newCCB
->PtrFileObject
= FileObject
;
278 Fcb
->FileObject
= FileObject
;
281 Status
= STATUS_SUCCESS
;
284 CcInitializeCacheMap(FileObject
,
285 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
287 &(NtfsGlobalData
->CacheMgrCallbacks
),
290 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
292 FileObject
->FsContext2
= NULL
;
293 ExFreePoolWithTag(newCCB
, TAG_CCB
);
294 ObDereferenceObject(FileObject
);
295 Fcb
->FileObject
= NULL
;
296 return _SEH2_GetExceptionCode();
300 ObDereferenceObject(FileObject
);
301 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
308 NtfsMakeRootFCB(PNTFS_VCB Vcb
)
311 PFILE_RECORD_HEADER MftRecord
;
312 PFILENAME_ATTRIBUTE FileName
;
314 MftRecord
= ExAllocatePoolWithTag(NonPagedPool
,
315 Vcb
->NtfsInfo
.BytesPerFileRecord
,
317 if (MftRecord
== NULL
)
322 if (!NT_SUCCESS(ReadFileRecord(Vcb
, NTFS_FILE_ROOT
, MftRecord
)))
324 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
328 FileName
= GetFileNameFromRecord(Vcb
, MftRecord
, NTFS_FILE_NAME_WIN32
);
331 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
335 Fcb
= NtfsCreateFCB(L
"\\", NULL
, Vcb
);
338 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
342 memcpy(&Fcb
->Entry
, FileName
, FIELD_OFFSET(FILENAME_ATTRIBUTE
, NameLength
));
343 Fcb
->Entry
.NameType
= FileName
->NameType
;
344 Fcb
->Entry
.NameLength
= 0;
345 Fcb
->Entry
.Name
[0] = UNICODE_NULL
;
348 Fcb
->RFCB
.FileSize
.QuadPart
= FileName
->DataSize
;
349 Fcb
->RFCB
.ValidDataLength
.QuadPart
= FileName
->DataSize
;
350 Fcb
->RFCB
.AllocationSize
.QuadPart
= FileName
->AllocatedSize
;
351 Fcb
->MFTIndex
= NTFS_FILE_ROOT
;
352 Fcb
->LinkCount
= MftRecord
->LinkCount
;
354 NtfsFCBInitializeCache(Vcb
, Fcb
);
355 NtfsAddFCBToTable(Vcb
, Fcb
);
356 NtfsGrabFCB(Vcb
, Fcb
);
358 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
365 NtfsOpenRootFCB(PNTFS_VCB Vcb
)
369 Fcb
= NtfsGrabFCBFromTable(Vcb
, L
"\\");
372 Fcb
= NtfsMakeRootFCB(Vcb
);
380 NtfsMakeFCBFromDirEntry(PNTFS_VCB Vcb
,
381 PNTFS_FCB DirectoryFCB
,
382 PUNICODE_STRING Name
,
384 PFILE_RECORD_HEADER Record
,
388 WCHAR pathName
[MAX_PATH
];
389 PFILENAME_ATTRIBUTE FileName
;
390 PSTANDARD_INFORMATION StdInfo
;
392 ULONGLONG Size
, AllocatedSize
;
394 DPRINT1("NtfsMakeFCBFromDirEntry(%p, %p, %wZ, %p, %p, %p)\n", Vcb
, DirectoryFCB
, Name
, Stream
, Record
, fileFCB
);
396 FileName
= GetBestFileNameFromRecord(Vcb
, Record
);
399 return STATUS_OBJECT_NAME_NOT_FOUND
; // Not sure that's the best here
402 if (DirectoryFCB
&& Name
)
404 if (Name
->Buffer
[0] != 0 && wcslen(DirectoryFCB
->PathName
) +
405 sizeof(WCHAR
) + Name
->Length
/ sizeof(WCHAR
) > MAX_PATH
)
407 return STATUS_OBJECT_NAME_INVALID
;
410 wcscpy(pathName
, DirectoryFCB
->PathName
);
411 if (!NtfsFCBIsRoot(DirectoryFCB
))
413 wcscat(pathName
, L
"\\");
415 wcscat(pathName
, Name
->Buffer
);
419 RtlCopyMemory(pathName
, FileName
->Name
, FileName
->NameLength
* sizeof (WCHAR
));
420 pathName
[FileName
->NameLength
] = UNICODE_NULL
;
423 Size
= NtfsGetFileSize(Vcb
, Record
, (Stream
? Stream
: L
""), (Stream
? wcslen(Stream
) : 0), &AllocatedSize
);
425 rcFCB
= NtfsCreateFCB(pathName
, Stream
, Vcb
);
428 return STATUS_INSUFFICIENT_RESOURCES
;
431 memcpy(&rcFCB
->Entry
, FileName
, FIELD_OFFSET(FILENAME_ATTRIBUTE
, NameLength
));
432 rcFCB
->Entry
.NameType
= FileName
->NameType
;
433 rcFCB
->RFCB
.FileSize
.QuadPart
= Size
;
434 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= Size
;
435 rcFCB
->RFCB
.AllocationSize
.QuadPart
= AllocatedSize
;
437 StdInfo
= GetStandardInformationFromRecord(Vcb
, Record
);
440 rcFCB
->Entry
.FileAttributes
|= StdInfo
->FileAttribute
;
443 NtfsFCBInitializeCache(Vcb
, rcFCB
);
445 rcFCB
->MFTIndex
= MFTIndex
;
446 rcFCB
->LinkCount
= Record
->LinkCount
;
447 NtfsAddFCBToTable(Vcb
, rcFCB
);
450 return STATUS_SUCCESS
;
455 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb
,
457 PFILE_OBJECT FileObject
)
461 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
464 return STATUS_INSUFFICIENT_RESOURCES
;
467 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
469 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
470 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
472 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
473 FileObject
->FsContext
= Fcb
;
474 FileObject
->FsContext2
= newCCB
;
475 newCCB
->PtrFileObject
= FileObject
;
478 if (!(Fcb
->Flags
& FCB_CACHE_INITIALIZED
))
482 CcInitializeCacheMap(FileObject
,
483 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
485 &(NtfsGlobalData
->CacheMgrCallbacks
),
488 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
490 FileObject
->FsContext2
= NULL
;
491 ExFreePoolWithTag(newCCB
, TAG_CCB
);
492 return _SEH2_GetExceptionCode();
496 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
499 //DPRINT("file open: fcb:%x file size: %d\n", Fcb, Fcb->Entry.DataLengthL);
501 return STATUS_SUCCESS
;
506 NtfsDirFindFile(PNTFS_VCB Vcb
,
507 PNTFS_FCB DirectoryFcb
,
509 BOOLEAN CaseSensitive
,
513 ULONGLONG CurrentDir
;
515 PFILE_RECORD_HEADER FileRecord
;
517 PWSTR Colon
, OldColon
;
518 PNTFS_ATTR_CONTEXT DataContext
;
521 DPRINT1("NtfsDirFindFile(%p, %p, %S, %s, %p)\n",
525 CaseSensitive
? "TRUE" : "FALSE",
529 RtlInitUnicodeString(&File
, FileToFind
);
530 CurrentDir
= DirectoryFcb
->MFTIndex
;
532 Colon
= wcsrchr(FileToFind
, L
':');
535 Length
= File
.Length
;
536 File
.Length
= (Colon
- FileToFind
) * sizeof(WCHAR
);
538 if (_wcsicmp(Colon
+ 1, L
"$DATA") == 0)
541 Colon
[0] = UNICODE_NULL
;
542 Colon
= wcsrchr(FileToFind
, L
':');
545 Length
= File
.Length
;
546 File
.Length
= (Colon
- FileToFind
) * sizeof(WCHAR
);
557 DPRINT1("Will now look for file '%wZ' with stream '%S'\n", &File
, Colon
);
560 Status
= NtfsLookupFileAt(Vcb
, &File
, &FileRecord
, &MFTIndex
, CurrentDir
, CaseSensitive
);
561 if (!NT_SUCCESS(Status
))
568 File
.Length
= Length
;
571 if ((FileRecord
->Flags
& FRH_DIRECTORY
) && Colon
!= 0)
573 return STATUS_INVALID_PARAMETER
;
577 Status
= FindAttribute(Vcb
, FileRecord
, AttributeData
, Colon
, wcslen(Colon
), &DataContext
, NULL
);
578 if (!NT_SUCCESS(Status
))
580 return STATUS_OBJECT_NAME_NOT_FOUND
;
582 ReleaseAttributeContext(DataContext
);
585 Status
= NtfsMakeFCBFromDirEntry(Vcb
, DirectoryFcb
, &File
, Colon
, FileRecord
, MFTIndex
, FoundFCB
);
586 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
593 NtfsGetFCBForFile(PNTFS_VCB Vcb
,
594 PNTFS_FCB
*pParentFCB
,
596 const PWSTR pFileName
,
597 BOOLEAN CaseSensitive
)
600 WCHAR pathName
[MAX_PATH
];
601 WCHAR elementName
[MAX_PATH
];
602 PWCHAR currentElement
;
606 DPRINT("NtfsGetFCBForFile(%p, %p, %p, '%S', %s)\n",
611 CaseSensitive
? "TRUE" : "FALSE");
614 // FCB = NtfsOpenRootFCB(Vcb);
616 // *pParentFCB = NULL;
619 /* Trivial case, open of the root directory on volume */
620 if (pFileName
[0] == L
'\0' || wcscmp(pFileName
, L
"\\") == 0)
622 DPRINT("returning root FCB\n");
624 FCB
= NtfsOpenRootFCB(Vcb
);
628 return (FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
;
632 currentElement
= pFileName
+ 1;
633 wcscpy (pathName
, L
"\\");
634 FCB
= NtfsOpenRootFCB (Vcb
);
639 /* Parse filename and check each path element for existence and access */
640 while (NtfsGetNextPathElement(currentElement
) != 0)
642 /* Skip blank directory levels */
643 if ((NtfsGetNextPathElement(currentElement
) - currentElement
) == 0)
649 DPRINT("Parsing, currentElement:%S\n", currentElement
);
650 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
652 /* Descend to next directory level */
655 NtfsReleaseFCB(Vcb
, parentFCB
);
659 /* fail if element in FCB is not a directory */
660 if (!NtfsFCBIsDirectory(FCB
))
662 DPRINT("Element in requested path is not a directory\n");
664 NtfsReleaseFCB(Vcb
, FCB
);
669 return STATUS_OBJECT_PATH_NOT_FOUND
;
674 /* Extract next directory level into dirName */
675 NtfsWSubString(pathName
,
677 NtfsGetNextPathElement(currentElement
) - pFileName
);
678 DPRINT(" pathName:%S\n", pathName
);
680 FCB
= NtfsGrabFCBFromTable(Vcb
, pathName
);
683 NtfsWSubString(elementName
,
685 NtfsGetNextPathElement(currentElement
) - currentElement
);
686 DPRINT(" elementName:%S\n", elementName
);
688 Status
= NtfsDirFindFile(Vcb
, parentFCB
, elementName
, CaseSensitive
, &FCB
);
689 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
691 *pParentFCB
= parentFCB
;
693 currentElement
= NtfsGetNextPathElement(currentElement
);
694 if (*currentElement
== L
'\0' || NtfsGetNextPathElement(currentElement
+ 1) == 0)
696 return STATUS_OBJECT_NAME_NOT_FOUND
;
700 return STATUS_OBJECT_PATH_NOT_FOUND
;
703 else if (!NT_SUCCESS(Status
))
705 NtfsReleaseFCB(Vcb
, parentFCB
);
713 currentElement
= NtfsGetNextPathElement(currentElement
);
716 *pParentFCB
= parentFCB
;
720 return STATUS_SUCCESS
;
725 NtfsReadFCBAttribute(PNTFS_VCB Vcb
,
733 PFILE_RECORD_HEADER FileRecord
;
734 PNTFS_ATTR_CONTEXT AttrCtxt
;
735 ULONGLONG AttrLength
;
737 FileRecord
= ExAllocatePoolWithTag(NonPagedPool
,
738 Vcb
->NtfsInfo
.BytesPerFileRecord
,
740 if (FileRecord
== NULL
)
742 return STATUS_INSUFFICIENT_RESOURCES
;
745 Status
= ReadFileRecord(Vcb
, pFCB
->MFTIndex
, FileRecord
);
746 if (!NT_SUCCESS(Status
))
748 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
752 Status
= FindAttribute(Vcb
, FileRecord
, Type
, Name
, NameLength
, &AttrCtxt
, NULL
);
753 if (!NT_SUCCESS(Status
))
755 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
759 AttrLength
= AttributeDataLength(&AttrCtxt
->Record
);
760 *Data
= ExAllocatePoolWithTag(NonPagedPool
, AttrLength
, TAG_NTFS
);
763 ReleaseAttributeContext(AttrCtxt
);
764 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
765 return STATUS_INSUFFICIENT_RESOURCES
;
768 ReadAttribute(Vcb
, AttrCtxt
, 0, *Data
, AttrLength
);
770 ReleaseAttributeContext(AttrCtxt
);
771 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
773 return STATUS_SUCCESS
;