cleanup.c

Go to the documentation of this file.

/*
 *  ReactOS kernel
 *  Copyright (C) 2016 ReactOS Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * COPYRIGHT:        See COPYING in the top level directory
 * PROJECT:          ReactOS kernel
 * FILE:             drivers/filesystem/ntfs/cleanup.c
 * PURPOSE:          NTFS filesystem driver
 * PROGRAMMER:       Pierre Schweitzer (pierre@reactos.org)
 * UPDATE HISTORY:
 */
 
/* INCLUDES *****************************************************************/
 
#include "ntfs.h"
 
#define NDEBUG
#include <debug.h>
 
/* FUNCTIONS ****************************************************************/
 
/*
 * FUNCTION: Cleans up a file
 */
NTSTATUS
NtfsCleanupFile(PDEVICE_EXTENSION DeviceExt,
                PFILE_OBJECT FileObject,
                BOOLEAN CanWait)
{
    PNTFS_FCB Fcb;
    BOOLEAN DeletePending = FALSE;
 
    DPRINT("NtfsCleanupFile(DeviceExt %p, FileObject %p, CanWait %u)\n",
           DeviceExt,
           FileObject,
           CanWait);
 
    Fcb = (PNTFS_FCB)(FileObject->FsContext);
    if (!Fcb)
        return STATUS_SUCCESS;
 
    if (Fcb->Flags & FCB_IS_VOLUME)
    {
        Fcb->OpenHandleCount--;
 
        if (Fcb->OpenHandleCount != 0)
        {
            // Remove share access when handled
        }
    }
    else
    {
        if (!ExAcquireResourceExclusiveLite(&Fcb->MainResource, CanWait))
        {
            return STATUS_PENDING;
        }
 
        Fcb->OpenHandleCount--;
 
        if (Fcb->ShareAccess.OpenCount > 0)
        {
            IoRemoveShareAccess(FileObject, &Fcb->ShareAccess);
        }
 
        /* A file marked for deletion goes on the last handle. Truncate it first, so the cache
         * manager drops its pages while there are still clusters to write them back to. */
        if (Fcb->OpenHandleCount == 0 &&
            BooleanFlagOn(Fcb->Flags, FCB_DELETE_PENDING))
        {
            DeletePending = TRUE;
 
            if (!NtfsFCBIsDirectory(Fcb))
            {
                Fcb->RFCB.FileSize.QuadPart = 0;
                Fcb->RFCB.ValidDataLength.QuadPart = 0;
                CcSetFileSizes(FileObject, (PCC_FILE_SIZES)&Fcb->RFCB.AllocationSize);
            }
        }
 
        /* Give back what writes reserved past the end of the file */
        if (Fcb->OpenHandleCount == 0 &&
            !DeletePending &&
            !NtfsFCBIsDirectory(Fcb) &&
            !(DeviceExt->Flags & VCB_VOLUME_DISMOUNTED) &&
            Fcb->RFCB.AllocationSize.QuadPart > (LONGLONG)ROUND_UP(Fcb->RFCB.FileSize.QuadPart, DeviceExt->NtfsInfo.BytesPerCluster))
        {
            NTSTATUS Status;
 
            Status = NtfsTrimAllocation(Fcb);
            if (!NT_SUCCESS(Status))
            {
                DPRINT1("Couldn't trim the allocation of '%wS' (Status %lx)\n", Fcb->ObjectName, Status);
            }
            else
            {
                CcSetFileSizes(FileObject, (PCC_FILE_SIZES)&Fcb->RFCB.AllocationSize);
            }
        }
 
        CcUninitializeCacheMap(FileObject, &Fcb->RFCB.FileSize, NULL);
 
        /* Only once the cache map is gone. Freeing the record while a section still refers to
         * it faults Mm on the next page-in. */
        if (DeletePending)
        {
            NTSTATUS Status;
 
            MmFlushImageSection(&Fcb->SectionObjectPointers, MmFlushForDelete);
 
            /* Something may have been created in the directory since the delete
             * was requested; freeing it now would orphan that child */
            Status = STATUS_SUCCESS;
            if (NtfsFCBIsDirectory(Fcb))
            {
                BOOLEAN Empty;
 
                KeEnterCriticalRegion();
                ExAcquireResourceSharedLite(&DeviceExt->IndexResource, TRUE);
                Status = NtfsIsDirectoryEmpty(DeviceExt, Fcb->MFTIndex, &Empty);
                ExReleaseResourceLite(&DeviceExt->IndexResource);
                KeLeaveCriticalRegion();
 
                if (NT_SUCCESS(Status) && !Empty)
                    Status = STATUS_DIRECTORY_NOT_EMPTY;
            }
 
            if (NT_SUCCESS(Status))
                Status = NtfsDeleteFileRecord(DeviceExt, Fcb->MFTIndex, FALSE);
 
            /* A cached FCB for a path that no longer exists would make it look present */
            if (NT_SUCCESS(Status))
                NtfsRemoveFCBFromTable(DeviceExt, Fcb);
 
            if (!NT_SUCCESS(Status))
            {
                DPRINT1("ERROR: Failed to delete '%wS' (MFT record %I64u), Status %lx\n",
                        Fcb->ObjectName, Fcb->MFTIndex, Status);
            }
 
            Fcb->Flags &= ~FCB_DELETE_PENDING;
        }
 
        if (Fcb->OpenHandleCount != 0)
        {
            // Remove share access when handled
        }
 
        FileObject->Flags |= FO_CLEANUP_COMPLETE;
 
        ExReleaseResourceLite(&Fcb->MainResource);
    }
 
    return STATUS_SUCCESS;
}
 
NTSTATUS
NtfsCleanup(PNTFS_IRP_CONTEXT IrpContext)
{
    PDEVICE_EXTENSION DeviceExtension;
    PFILE_OBJECT FileObject;
    NTSTATUS Status;
    PDEVICE_OBJECT DeviceObject;
 
    DPRINT("NtfsCleanup() called\n");
 
    DeviceObject = IrpContext->DeviceObject;
    if (DeviceObject == NtfsGlobalData->DeviceObject)
    {
        DPRINT("Cleaning up file system\n");
        IrpContext->Irp->IoStatus.Information = 0;
        return STATUS_SUCCESS;
    }
 
    FileObject = IrpContext->FileObject;
    DeviceExtension = DeviceObject->DeviceExtension;
 
    if (!ExAcquireResourceExclusiveLite(&DeviceExtension->DirResource,
                                        BooleanFlagOn(IrpContext->Flags, IRPCONTEXT_CANWAIT)))
    {
        return NtfsMarkIrpContextForQueue(IrpContext);
    }
 
    /* The handle is going away, and so are the locks it took */
    if (NtfsIsRegularFileObject(FileObject))
    {
        FsRtlFastUnlockAll(&((PNTFS_FCB)FileObject->FsContext)->FileLock,
                           FileObject,
                           IoGetRequestorProcess(IrpContext->Irp),
                           NULL);
    }
 
    Status = NtfsCleanupFile(DeviceExtension, FileObject, BooleanFlagOn(IrpContext->Flags, IRPCONTEXT_CANWAIT));
 
    ExReleaseResourceLite(&DeviceExtension->DirResource);
 
    if (Status == STATUS_PENDING)
    {
        return NtfsMarkIrpContextForQueue(IrpContext);
    }
 
    IrpContext->Irp->IoStatus.Information = 0;
    return Status;
}