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 /* MACROS *******************************************************************/
37 #define TAG_FCB 'BCFI'
39 /* FUNCTIONS ****************************************************************/
43 NtfsGetNextPathElement(PWCHAR FileName
)
45 if (*FileName
== L
'\0')
50 while (*FileName
!= L
'\0' && *FileName
!= L
'\\')
61 NtfsWSubString(PWCHAR pTarget
,
65 wcsncpy(pTarget
, pSource
, pLength
);
66 pTarget
[pLength
] = L
'\0';
71 NtfsCreateFCB(PCWSTR FileName
,
77 ASSERT(Vcb
->Identifier
.Type
== NTFS_TYPE_VCB
);
79 Fcb
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_FCB
), TAG_FCB
);
80 RtlZeroMemory(Fcb
, sizeof(NTFS_FCB
));
82 Fcb
->Identifier
.Type
= NTFS_TYPE_FCB
;
83 Fcb
->Identifier
.Size
= sizeof(NTFS_TYPE_FCB
);
89 wcscpy(Fcb
->PathName
, FileName
);
90 if (wcsrchr(Fcb
->PathName
, '\\') != 0)
92 Fcb
->ObjectName
= wcsrchr(Fcb
->PathName
, '\\');
96 Fcb
->ObjectName
= Fcb
->PathName
;
100 ExInitializeResourceLite(&Fcb
->MainResource
);
102 Fcb
->RFCB
.Resource
= &(Fcb
->MainResource
);
109 NtfsDestroyFCB(PNTFS_FCB Fcb
)
112 ASSERT(Fcb
->Identifier
.Type
== NTFS_TYPE_FCB
);
114 ExDeleteResourceLite(&Fcb
->MainResource
);
121 NtfsFCBIsDirectory(PNTFS_FCB Fcb
)
123 return ((Fcb
->Entry
.FileAttributes
& NTFS_FILE_TYPE_DIRECTORY
) == NTFS_FILE_TYPE_DIRECTORY
);
128 NtfsFCBIsReparsePoint(PNTFS_FCB Fcb
)
130 return ((Fcb
->Entry
.FileAttributes
& NTFS_FILE_TYPE_REPARSE
) == NTFS_FILE_TYPE_REPARSE
);
135 NtfsFCBIsRoot(PNTFS_FCB Fcb
)
137 return (wcscmp(Fcb
->PathName
, L
"\\") == 0);
142 NtfsGrabFCB(PNTFS_VCB Vcb
,
147 DPRINT("grabbing FCB at %p: %S, refCount:%d\n",
152 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
154 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
159 NtfsReleaseFCB(PNTFS_VCB Vcb
,
164 DPRINT("releasing FCB at %p: %S, refCount:%d\n",
169 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
171 if (Fcb
->RefCount
<= 0 && !NtfsFCBIsDirectory(Fcb
))
173 RemoveEntryList(&Fcb
->FcbListEntry
);
174 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
175 CcUninitializeCacheMap(Fcb
->FileObject
, NULL
, NULL
);
180 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
186 NtfsAddFCBToTable(PNTFS_VCB Vcb
,
191 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
193 InsertTailList(&Vcb
->FcbListHead
, &Fcb
->FcbListEntry
);
194 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
199 NtfsGrabFCBFromTable(PNTFS_VCB Vcb
,
204 PLIST_ENTRY current_entry
;
206 KeAcquireSpinLock(&Vcb
->FcbListLock
, &oldIrql
);
208 if (FileName
== NULL
|| *FileName
== 0)
210 DPRINT("Return FCB for stream file object\n");
211 Fcb
= Vcb
->StreamFileObject
->FsContext
;
213 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
217 current_entry
= Vcb
->FcbListHead
.Flink
;
218 while (current_entry
!= &Vcb
->FcbListHead
)
220 Fcb
= CONTAINING_RECORD(current_entry
, NTFS_FCB
, FcbListEntry
);
222 DPRINT("Comparing '%S' and '%S'\n", FileName
, Fcb
->PathName
);
223 if (_wcsicmp(FileName
, Fcb
->PathName
) == 0)
226 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
230 //FIXME: need to compare against short name in FCB here
232 current_entry
= current_entry
->Flink
;
235 KeReleaseSpinLock(&Vcb
->FcbListLock
, oldIrql
);
242 NtfsFCBInitializeCache(PNTFS_VCB Vcb
,
245 PFILE_OBJECT FileObject
;
249 FileObject
= IoCreateStreamFileObject(NULL
, Vcb
->StorageDevice
);
251 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
254 return STATUS_INSUFFICIENT_RESOURCES
;
257 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
259 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
260 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
262 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
263 FileObject
->FsContext
= Fcb
;
264 FileObject
->FsContext2
= newCCB
;
265 newCCB
->PtrFileObject
= FileObject
;
266 Fcb
->FileObject
= FileObject
;
269 Status
= STATUS_SUCCESS
;
270 CcInitializeCacheMap(FileObject
,
271 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
273 &(NtfsGlobalData
->CacheMgrCallbacks
),
276 ObDereferenceObject(FileObject
);
277 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
284 NtfsMakeRootFCB(PNTFS_VCB Vcb
)
287 PFILE_RECORD_HEADER MftRecord
;
288 PFILENAME_ATTRIBUTE FileName
;
290 MftRecord
= ExAllocatePoolWithTag(NonPagedPool
,
291 Vcb
->NtfsInfo
.BytesPerFileRecord
,
293 if (MftRecord
== NULL
)
298 if (!NT_SUCCESS(ReadFileRecord(Vcb
, NTFS_FILE_ROOT
, MftRecord
)))
300 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
304 FileName
= GetFileNameFromRecord(MftRecord
, NTFS_FILE_NAME_WIN32
);
307 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
311 Fcb
= NtfsCreateFCB(L
"\\", Vcb
);
314 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
318 memcpy(&Fcb
->Entry
, FileName
, FIELD_OFFSET(FILENAME_ATTRIBUTE
, NameLength
));
319 Fcb
->Entry
.NameType
= FileName
->NameType
;
320 Fcb
->Entry
.NameLength
= 0;
321 Fcb
->Entry
.Name
[0] = UNICODE_NULL
;
324 Fcb
->RFCB
.FileSize
.QuadPart
= FileName
->DataSize
;
325 Fcb
->RFCB
.ValidDataLength
.QuadPart
= FileName
->DataSize
;
326 Fcb
->RFCB
.AllocationSize
.QuadPart
= FileName
->AllocatedSize
;
327 Fcb
->MFTIndex
= NTFS_FILE_ROOT
;
329 NtfsFCBInitializeCache(Vcb
, Fcb
);
330 NtfsAddFCBToTable(Vcb
, Fcb
);
331 NtfsGrabFCB(Vcb
, Fcb
);
333 ExFreePoolWithTag(MftRecord
, TAG_NTFS
);
340 NtfsOpenRootFCB(PNTFS_VCB Vcb
)
344 Fcb
= NtfsGrabFCBFromTable(Vcb
, L
"\\");
347 Fcb
= NtfsMakeRootFCB(Vcb
);
356 NtfsGetDirEntryName(PDEVICE_EXTENSION DeviceExt
,
360 * FUNCTION: Retrieves the file name, be it in short or long file name format
363 if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 0)
367 else if (Record
->FileIdLength
== 1 && Record
->FileId
[0] == 1)
373 if (DeviceExt
->CdInfo
.JolietLevel
== 0)
377 for (i
= 0; i
< Record
->FileIdLength
&& Record
->FileId
[i
] != ';'; i
++)
378 Name
[i
] = (WCHAR
)Record
->FileId
[i
];
383 NtfsSwapString(Name
, Record
->FileId
, Record
->FileIdLength
);
387 DPRINT("Name '%S'\n", Name
);
393 NtfsMakeFCBFromDirEntry(PNTFS_VCB Vcb
,
394 PNTFS_FCB DirectoryFCB
,
395 PUNICODE_STRING Name
,
396 PFILE_RECORD_HEADER Record
,
400 WCHAR pathName
[MAX_PATH
];
401 PFILENAME_ATTRIBUTE FileName
;
404 DPRINT1("NtfsMakeFCBFromDirEntry(%p, %p, %wZ, %p, %p)\n", Vcb
, DirectoryFCB
, Name
, Record
, fileFCB
);
406 FileName
= GetBestFileNameFromRecord(Record
);
409 return STATUS_OBJECT_NAME_NOT_FOUND
; // Not sure that's the best here
412 if (Name
->Buffer
[0] != 0 && wcslen(DirectoryFCB
->PathName
) +
413 sizeof(WCHAR
) + Name
->Length
/ sizeof(WCHAR
) > MAX_PATH
)
415 return STATUS_OBJECT_NAME_INVALID
;
418 wcscpy(pathName
, DirectoryFCB
->PathName
);
419 if (!NtfsFCBIsRoot(DirectoryFCB
))
421 wcscat(pathName
, L
"\\");
423 wcscat(pathName
, Name
->Buffer
);
425 rcFCB
= NtfsCreateFCB(pathName
, 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
= FileName
->DataSize
;
434 rcFCB
->RFCB
.ValidDataLength
.QuadPart
= FileName
->DataSize
;
435 rcFCB
->RFCB
.AllocationSize
.QuadPart
= FileName
->AllocatedSize
;
437 NtfsFCBInitializeCache(Vcb
, rcFCB
);
439 rcFCB
->MFTIndex
= MFTIndex
;
440 NtfsAddFCBToTable(Vcb
, rcFCB
);
443 return STATUS_SUCCESS
;
448 NtfsAttachFCBToFileObject(PNTFS_VCB Vcb
,
450 PFILE_OBJECT FileObject
)
454 newCCB
= ExAllocatePoolWithTag(NonPagedPool
, sizeof(NTFS_CCB
), TAG_CCB
);
457 return STATUS_INSUFFICIENT_RESOURCES
;
460 RtlZeroMemory(newCCB
, sizeof(NTFS_CCB
));
462 newCCB
->Identifier
.Type
= NTFS_TYPE_CCB
;
463 newCCB
->Identifier
.Size
= sizeof(NTFS_TYPE_CCB
);
465 FileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
466 FileObject
->FsContext
= Fcb
;
467 FileObject
->FsContext2
= newCCB
;
468 newCCB
->PtrFileObject
= FileObject
;
471 if (!(Fcb
->Flags
& FCB_CACHE_INITIALIZED
))
473 CcInitializeCacheMap(FileObject
,
474 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
476 &(NtfsGlobalData
->CacheMgrCallbacks
),
479 Fcb
->Flags
|= FCB_CACHE_INITIALIZED
;
482 //DPRINT("file open: fcb:%x file size: %d\n", Fcb, Fcb->Entry.DataLengthL);
484 return STATUS_SUCCESS
;
489 NtfsDirFindFile(PNTFS_VCB Vcb
,
490 PNTFS_FCB DirectoryFcb
,
495 ULONGLONG CurrentDir
;
497 PFILE_RECORD_HEADER FileRecord
;
498 PNTFS_ATTR_CONTEXT DataContext
;
501 DPRINT1("NtfsDirFindFile(%p, %p, %S, %p)\n", Vcb
, DirectoryFcb
, FileToFind
, FoundFCB
);
504 RtlInitUnicodeString(&File
, FileToFind
);
505 CurrentDir
= DirectoryFcb
->MFTIndex
;
507 Status
= NtfsLookupFileAt(Vcb
, &File
, &FileRecord
, &DataContext
, &MFTIndex
, CurrentDir
);
508 if (!NT_SUCCESS(Status
))
513 Status
= NtfsMakeFCBFromDirEntry(Vcb
, DirectoryFcb
, &File
, FileRecord
, MFTIndex
, FoundFCB
);
514 ExFreePoolWithTag(FileRecord
, TAG_NTFS
);
521 NtfsGetFCBForFile(PNTFS_VCB Vcb
,
522 PNTFS_FCB
*pParentFCB
,
524 const PWSTR pFileName
)
527 WCHAR pathName
[MAX_PATH
];
528 WCHAR elementName
[MAX_PATH
];
529 PWCHAR currentElement
;
533 DPRINT("NtfsGetFCBForFile(%p, %p, %p, '%S')\n",
540 // FCB = NtfsOpenRootFCB(Vcb);
542 // *pParentFCB = NULL;
545 /* Trivial case, open of the root directory on volume */
546 if (pFileName
[0] == L
'\0' || wcscmp(pFileName
, L
"\\") == 0)
548 DPRINT("returning root FCB\n");
550 FCB
= NtfsOpenRootFCB(Vcb
);
554 return (FCB
!= NULL
) ? STATUS_SUCCESS
: STATUS_OBJECT_PATH_NOT_FOUND
;
558 currentElement
= pFileName
+ 1;
559 wcscpy (pathName
, L
"\\");
560 FCB
= NtfsOpenRootFCB (Vcb
);
565 /* Parse filename and check each path element for existance and access */
566 while (NtfsGetNextPathElement(currentElement
) != 0)
568 /* Skip blank directory levels */
569 if ((NtfsGetNextPathElement(currentElement
) - currentElement
) == 0)
575 DPRINT("Parsing, currentElement:%S\n", currentElement
);
576 DPRINT(" parentFCB:%p FCB:%p\n", parentFCB
, FCB
);
578 /* Descend to next directory level */
581 NtfsReleaseFCB(Vcb
, parentFCB
);
585 /* fail if element in FCB is not a directory */
586 if (!NtfsFCBIsDirectory(FCB
))
588 DPRINT("Element in requested path is not a directory\n");
590 NtfsReleaseFCB(Vcb
, FCB
);
595 return STATUS_OBJECT_PATH_NOT_FOUND
;
600 /* Extract next directory level into dirName */
601 NtfsWSubString(pathName
,
603 NtfsGetNextPathElement(currentElement
) - pFileName
);
604 DPRINT(" pathName:%S\n", pathName
);
606 FCB
= NtfsGrabFCBFromTable(Vcb
, pathName
);
609 NtfsWSubString(elementName
,
611 NtfsGetNextPathElement(currentElement
) - currentElement
);
612 DPRINT(" elementName:%S\n", elementName
);
614 Status
= NtfsDirFindFile(Vcb
, parentFCB
, elementName
, &FCB
);
615 if (Status
== STATUS_OBJECT_NAME_NOT_FOUND
)
617 *pParentFCB
= parentFCB
;
619 currentElement
= NtfsGetNextPathElement(currentElement
);
620 if (*currentElement
== L
'\0' || NtfsGetNextPathElement(currentElement
+ 1) == 0)
622 return STATUS_OBJECT_NAME_NOT_FOUND
;
626 return STATUS_OBJECT_PATH_NOT_FOUND
;
629 else if (!NT_SUCCESS(Status
))
631 NtfsReleaseFCB(Vcb
, parentFCB
);
639 currentElement
= NtfsGetNextPathElement(currentElement
);
642 *pParentFCB
= parentFCB
;
646 return STATUS_SUCCESS
;