Changeset 78339 in vbox for trunk/src

Timestamp:

Apr 28, 2019 11:38:32 AM (6 years ago)

Author:

vboxsync

Message:

winnt/vboxsf: Contiuing cleaning up VBoxMRxSetFileInfo; moving stuff to improve locality somewhat. bugref:9172

Location:

trunk/src/VBox/Additions/WINNT/SharedFolders/driver

Files:

• file.cpp (modified) (4 diffs)
• info.cpp (modified) (3 diffs)
• path.cpp (modified) (5 diffs)
• vbsf.h (modified) (1 diff)

trunk/src/VBox/Additions/WINNT/SharedFolders/driver/file.cpp

@@ -260 +260 @@
          ByteCount, ByteOffset, FileSize));
 
-    /** @todo check if this is necessary. */
+/** @todo r=bird: This check is incorrect as we must let the host do these
+ * checks with up-to-date end-of-file data.  What we've got cached here is
+ * potentially out of date.  (This code is here because someone saw it in some
+ * sample, I suspect and didn't quite understand what it was all about.  The
+ * thing is that when FCB_STATE_READCACHING_ENABLED is set, the caller
+ * already checks and the sample probably wanted to cover its bases.  We,
+ * don't want to do that as already explained earlier.) */
 #ifdef FCB_STATE_READCACHING_ENABLED    /* Correct spelling for Vista 6001 SDK. */
     if (!FlagOn(capFcb->FcbState, FCB_STATE_READCACHING_ENABLED))
@@ -267 +273 @@
 #endif
     {
-/** @todo r=bird: How is this file size accurate given that the file resides
- *        on the host and be grown/shrunk independently there?   Why is this
- *        only done when FCB_STATE_READCACHEING_ENABLED is clear? */
         if (ByteOffset >= FileSize)
         {
@@ -313 +316 @@
     RxContext->InformationToReturn = ByteCount;
 
+/** @todo if we read past the end-of-file as we know it, or if we reached
+ * end-of-file earlier than we though, update the file size.  The
+ * RxLowIoReadShellCompletion() routine does not seem to do this for is and
+ * I (bird) couldn't find anyone else doing it either. */
+
     Log(("VBOXSF: vbsfReadInternal: Status = 0x%08X, ByteCount = 0x%X\n",
          Status, ByteCount));
@@ -554 +562 @@
 }
 
-NTSTATUS vbsfNtSetEndOfFile(IN OUT struct _RX_CONTEXT * RxContext,
-                            IN uint64_t cbNewFileSize)
-{
-    NTSTATUS Status = STATUS_SUCCESS;
-
-    RxCaptureFcb;
-    RxCaptureFobx;
-
-    PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension = VBoxMRxGetNetRootExtension(capFcb->pNetRoot);
-    PMRX_VBOX_FOBX pVBoxFobx = VBoxMRxGetFileObjectExtension(capFobx);
-
-    PSHFLFSOBJINFO pObjInfo;
-    uint32_t cbBuffer;
-    int vrc;
-
-    Log(("VBOXSF: vbsfNtSetEndOfFile: New size = %RX64\n",
-         cbNewFileSize));
-
-    Assert(pVBoxFobx && pNetRootExtension);
-
-    cbBuffer = sizeof(SHFLFSOBJINFO);
-    pObjInfo = (SHFLFSOBJINFO *)vbsfNtAllocNonPagedMem(cbBuffer);
-    if (!pObjInfo)
-    {
-        AssertFailed();
-        return STATUS_INSUFFICIENT_RESOURCES;
-    }
-
-    RtlZeroMemory(pObjInfo, cbBuffer);
-    pObjInfo->cbObject = cbNewFileSize;
-
-    vrc = VbglR0SfFsInfo(&g_SfClient, &pNetRootExtension->map, pVBoxFobx->hFile,
-                         SHFL_INFO_SET | SHFL_INFO_SIZE, &cbBuffer, (PSHFLDIRINFO)pObjInfo);
-
-    Log(("VBOXSF: vbsfNtSetEndOfFile: VbglR0SfFsInfo returned %Rrc\n", vrc));
-
-    Status = vbsfNtVBoxStatusToNt(vrc);
-    if (Status == STATUS_SUCCESS)
-    {
-        Log(("VBOXSF: vbsfNtSetEndOfFile: VbglR0SfFsInfo new allocation size = %RX64\n",
-             pObjInfo->cbAllocated));
-
-        /** @todo update the file stats! */
-    }
-
-    if (pObjInfo)
-        vbsfNtFreeNonPagedMem(pObjInfo);
-
-    Log(("VBOXSF: vbsfNtSetEndOfFile: Returned 0x%08X\n", Status));
-    return Status;
-}
-
 /** See PMRX_EXTENDFILE_CALLDOWN in ddk/mrx.h
  *

trunk/src/VBox/Additions/WINNT/SharedFolders/driver/info.cpp

@@ -1273 +1273 @@
 }
 
+/**
+ * Worker for vbsfNtSetBasicInfo.
+ */
 static NTSTATUS vbsfNtSetBasicInfo(PMRX_VBOX_FOBX pVBoxFobx, PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension,
                                    PFILE_BASIC_INFORMATION pBasicInfo)
@@ -1407 +1410 @@
 }
 
+/**
+ * Worker for vbsfNtSetBasicInfo.
+ */
+static NTSTATUS vbsfNtSetEndOfFile(IN OUT struct _RX_CONTEXT * RxContext, IN uint64_t cbNewFileSize)
+{
+    NTSTATUS Status = STATUS_SUCCESS;
+
+    RxCaptureFcb;
+    RxCaptureFobx;
+
+    PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension = VBoxMRxGetNetRootExtension(capFcb->pNetRoot);
+    PMRX_VBOX_FOBX pVBoxFobx = VBoxMRxGetFileObjectExtension(capFobx);
+
+    PSHFLFSOBJINFO pObjInfo;
+    uint32_t cbBuffer;
+    int vrc;
+
+    Log(("VBOXSF: vbsfNtSetEndOfFile: New size = %RX64\n",
+         cbNewFileSize));
+
+    Assert(pVBoxFobx && pNetRootExtension);
+
+    cbBuffer = sizeof(SHFLFSOBJINFO);
+    pObjInfo = (SHFLFSOBJINFO *)vbsfNtAllocNonPagedMem(cbBuffer);
+    if (!pObjInfo)
+    {
+        AssertFailed();
+        return STATUS_INSUFFICIENT_RESOURCES;
+    }
+
+    RtlZeroMemory(pObjInfo, cbBuffer);
+    pObjInfo->cbObject = cbNewFileSize;
+
+    vrc = VbglR0SfFsInfo(&g_SfClient, &pNetRootExtension->map, pVBoxFobx->hFile,
+                         SHFL_INFO_SET | SHFL_INFO_SIZE, &cbBuffer, (PSHFLDIRINFO)pObjInfo);
+
+    Log(("VBOXSF: vbsfNtSetEndOfFile: VbglR0SfFsInfo returned %Rrc\n", vrc));
+
+    Status = vbsfNtVBoxStatusToNt(vrc);
+    if (Status == STATUS_SUCCESS)
+    {
+        Log(("VBOXSF: vbsfNtSetEndOfFile: VbglR0SfFsInfo new allocation size = %RX64\n",
+             pObjInfo->cbAllocated));
+
+        /** @todo update the file stats! */
+    }
+
+    if (pObjInfo)
+        vbsfNtFreeNonPagedMem(pObjInfo);
+
+    Log(("VBOXSF: vbsfNtSetEndOfFile: Returned 0x%08X\n", Status));
+    return Status;
+}
+
+/**
+ * Worker for vbsfNtSetBasicInfo.
+ */
+static NTSTATUS vbsfNtRename(IN PRX_CONTEXT RxContext,
+                             IN FILE_INFORMATION_CLASS FileInformationClass,
+                             IN PVOID pBuffer,
+                             IN ULONG BufferLength)
+{
+    NTSTATUS Status = STATUS_SUCCESS;
+
+    RxCaptureFcb;
+    RxCaptureFobx;
+
+    PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension = VBoxMRxGetNetRootExtension(capFcb->pNetRoot);
+    PMRX_VBOX_FOBX pVBoxFobx = VBoxMRxGetFileObjectExtension(capFobx);
+    PMRX_SRV_OPEN pSrvOpen = capFobx->pSrvOpen;
+
+    PFILE_RENAME_INFORMATION RenameInformation = (PFILE_RENAME_INFORMATION)RxContext->Info.Buffer;
+    PUNICODE_STRING RemainingName = GET_ALREADY_PREFIXED_NAME(pSrvOpen, capFcb);
+
+    int vrc;
+    PSHFLSTRING SrcPath = 0, DestPath = 0;
+    ULONG flags;
+
+    RT_NOREF(FileInformationClass, pBuffer, BufferLength);
+
+    Assert(FileInformationClass == FileRenameInformation);
+
+    Log(("VBOXSF: vbsfNtRename: FileName = %.*ls\n",
+         RenameInformation->FileNameLength / sizeof(WCHAR), &RenameInformation->FileName[0]));
+
+    /* Must close the file before renaming it! */
+    if (pVBoxFobx->hFile != SHFL_HANDLE_NIL)
+        vbsfNtCloseFileHandle(pNetRootExtension, pVBoxFobx);
+
+    /* Mark it as renamed, so we do nothing during close */
+    SetFlag(pSrvOpen->Flags, SRVOPEN_FLAG_FILE_RENAMED);
+
+    Log(("VBOXSF: vbsfNtRename: RenameInformation->FileNameLength = %d\n", RenameInformation->FileNameLength));
+    Status = vbsfNtShflStringFromUnicodeAlloc(&DestPath, RenameInformation->FileName, (uint16_t)RenameInformation->FileNameLength);
+    if (Status != STATUS_SUCCESS)
+        return Status;
+
+    Log(("VBOXSF: vbsfNtRename: Destination path = %.*ls\n",
+         DestPath->u16Length / sizeof(WCHAR), &DestPath->String.ucs2[0]));
+
+    Log(("VBOXSF: vbsfNtRename: RemainingName->Length = %d\n", RemainingName->Length));
+    Status = vbsfNtShflStringFromUnicodeAlloc(&SrcPath, RemainingName->Buffer, RemainingName->Length);
+    if (Status != STATUS_SUCCESS)
+    {
+        vbsfNtFreeNonPagedMem(DestPath);
+        return Status;
+    }
+
+    Log(("VBOXSF: vbsfNtRename: Source path = %.*ls\n",
+         SrcPath->u16Length / sizeof(WCHAR), &SrcPath->String.ucs2[0]));
+
+    /* Call host. */
+    flags = pVBoxFobx->Info.Attr.fMode & RTFS_DOS_DIRECTORY ? SHFL_RENAME_DIR : SHFL_RENAME_FILE;
+    if (RenameInformation->ReplaceIfExists)
+        flags |= SHFL_RENAME_REPLACE_IF_EXISTS;
+
+    Log(("VBOXSF: vbsfNtRename: Calling VbglR0SfRename\n"));
+    vrc = VbglR0SfRename(&g_SfClient, &pNetRootExtension->map, SrcPath, DestPath, flags);
+
+    vbsfNtFreeNonPagedMem(SrcPath);
+    vbsfNtFreeNonPagedMem(DestPath);
+
+    Status = vbsfNtVBoxStatusToNt(vrc);
+    if (vrc != VINF_SUCCESS)
+        Log(("VBOXSF: vbsfNtRename: VbglR0SfRename failed with %Rrc\n", vrc));
+
+    Log(("VBOXSF: vbsfNtRename: Returned 0x%08X\n", Status));
+    return Status;
+}
+
+
 NTSTATUS VBoxMRxSetFileInfo(IN PRX_CONTEXT RxContext)
 {
@@ -1465 +1599 @@
         }
 
+        /*
+         * Prior to calling us, RxSetEndOfFileInfo will have updated the FCB fields space.FileSize,
+         * Header.AllocationSize and (if old value was larger) Header.ValidDataLength.  On success
+         * it will inform the cache manager, while on failure the old values will be restored.
+         *
+         * Note! RxSetEndOfFileInfo assumes that the old Header.FileSize value is up to date and
+         *       will hide calls which does not change the size from us.  This is of course not
+         *       the case for non-local file systems, as the server is the only which up-to-date
+         *       information.  Don't see an easy way of working around it, so ignoring it for now.
+         */
         case FileEndOfFileInformation:
         {

trunk/src/VBox/Additions/WINNT/SharedFolders/driver/path.cpp

@@ -724 +724 @@
 }
 
-/*
+/**
  * Closes an opened file handle of a MRX_VBOX_FOBX.
+ *
  * Updates file attributes if necessary.
+ *
+ * Used by VBoxMRxCloseSrvOpen, vbsfNtRemove and vbsfNtRename.
  */
-static NTSTATUS vbsfCloseFileHandle(PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension,
-                                    PMRX_VBOX_FOBX pVBoxFobx)
+NTSTATUS vbsfNtCloseFileHandle(PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension,
+                               PMRX_VBOX_FOBX pVBoxFobx)
 {
     NTSTATUS Status = STATUS_SUCCESS;
@@ -803 +806 @@
     /* Close file */
     if (pVBoxFobx->hFile != SHFL_HANDLE_NIL)
-        vbsfCloseFileHandle(pNetRootExtension, pVBoxFobx);
+        vbsfNtCloseFileHandle(pNetRootExtension, pVBoxFobx);
 
     if (capFcb->FcbState & FCB_STATE_DELETE_ON_CLOSE)
@@ -818 +821 @@
 }
 
+/**
+ * Worker for vbsfNtSetBasicInfo and VBoxMRxCloseSrvOpen.
+ */
 NTSTATUS vbsfNtRemove(IN PRX_CONTEXT RxContext)
 {
@@ -838 +844 @@
     /* Close file first if not already done. */
     if (pVBoxFobx->hFile != SHFL_HANDLE_NIL)
-        vbsfCloseFileHandle(pNetRootExtension, pVBoxFobx);
+        vbsfNtCloseFileHandle(pNetRootExtension, pVBoxFobx);
 
     Log(("VBOXSF: vbsfNtRemove: RemainingName->Length %d\n", RemainingName->Length));
@@ -864 +870 @@
 }
 
-NTSTATUS vbsfNtRename(IN PRX_CONTEXT RxContext,
-                      IN FILE_INFORMATION_CLASS FileInformationClass,
-                      IN PVOID pBuffer,
-                      IN ULONG BufferLength)
-{
-    NTSTATUS Status = STATUS_SUCCESS;
-
-    RxCaptureFcb;
-    RxCaptureFobx;
-
-    PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension = VBoxMRxGetNetRootExtension(capFcb->pNetRoot);
-    PMRX_VBOX_FOBX pVBoxFobx = VBoxMRxGetFileObjectExtension(capFobx);
-    PMRX_SRV_OPEN pSrvOpen = capFobx->pSrvOpen;
-
-    PFILE_RENAME_INFORMATION RenameInformation = (PFILE_RENAME_INFORMATION)RxContext->Info.Buffer;
-    PUNICODE_STRING RemainingName = GET_ALREADY_PREFIXED_NAME(pSrvOpen, capFcb);
-
-    int vrc;
-    PSHFLSTRING SrcPath = 0, DestPath = 0;
-    ULONG flags;
-
-    RT_NOREF(FileInformationClass, pBuffer, BufferLength);
-
-    Assert(FileInformationClass == FileRenameInformation);
-
-    Log(("VBOXSF: vbsfNtRename: FileName = %.*ls\n",
-         RenameInformation->FileNameLength / sizeof(WCHAR), &RenameInformation->FileName[0]));
-
-    /* Must close the file before renaming it! */
-    if (pVBoxFobx->hFile != SHFL_HANDLE_NIL)
-        vbsfCloseFileHandle(pNetRootExtension, pVBoxFobx);
-
-    /* Mark it as renamed, so we do nothing during close */
-    SetFlag(pSrvOpen->Flags, SRVOPEN_FLAG_FILE_RENAMED);
-
-    Log(("VBOXSF: vbsfNtRename: RenameInformation->FileNameLength = %d\n", RenameInformation->FileNameLength));
-    Status = vbsfNtShflStringFromUnicodeAlloc(&DestPath, RenameInformation->FileName, (uint16_t)RenameInformation->FileNameLength);
-    if (Status != STATUS_SUCCESS)
-        return Status;
-
-    Log(("VBOXSF: vbsfNtRename: Destination path = %.*ls\n",
-         DestPath->u16Length / sizeof(WCHAR), &DestPath->String.ucs2[0]));
-
-    Log(("VBOXSF: vbsfNtRename: RemainingName->Length = %d\n", RemainingName->Length));
-    Status = vbsfNtShflStringFromUnicodeAlloc(&SrcPath, RemainingName->Buffer, RemainingName->Length);
-    if (Status != STATUS_SUCCESS)
-    {
-        vbsfNtFreeNonPagedMem(DestPath);
-        return Status;
-    }
-
-    Log(("VBOXSF: vbsfNtRename: Source path = %.*ls\n",
-         SrcPath->u16Length / sizeof(WCHAR), &SrcPath->String.ucs2[0]));
-
-    /* Call host. */
-    flags = pVBoxFobx->Info.Attr.fMode & RTFS_DOS_DIRECTORY ? SHFL_RENAME_DIR : SHFL_RENAME_FILE;
-    if (RenameInformation->ReplaceIfExists)
-        flags |= SHFL_RENAME_REPLACE_IF_EXISTS;
-
-    Log(("VBOXSF: vbsfNtRename: Calling VbglR0SfRename\n"));
-    vrc = VbglR0SfRename(&g_SfClient, &pNetRootExtension->map, SrcPath, DestPath, flags);
-
-    vbsfNtFreeNonPagedMem(SrcPath);
-    vbsfNtFreeNonPagedMem(DestPath);
-
-    Status = vbsfNtVBoxStatusToNt(vrc);
-    if (vrc != VINF_SUCCESS)
-        Log(("VBOXSF: vbsfNtRename: VbglR0SfRename failed with %Rrc\n", vrc));
-
-    Log(("VBOXSF: vbsfNtRename: Returned 0x%08X\n", Status));
-    return Status;
-}
-
 NTSTATUS VBoxMRxShouldTryToCollapseThisOpen(IN PRX_CONTEXT RxContext)
 {

trunk/src/VBox/Additions/WINNT/SharedFolders/driver/vbsf.h

@@ -219 +219 @@
 NTSTATUS vbsfNtCreateConnection(IN PRX_CONTEXT RxContext,
                                 OUT PBOOLEAN PostToFsp);
-
-NTSTATUS vbsfNtSetEndOfFile(IN OUT struct _RX_CONTEXT * RxContext,
-                            IN uint64_t cbNewFileSize);
-NTSTATUS vbsfNtRename(IN PRX_CONTEXT RxContext,
-                      IN FILE_INFORMATION_CLASS FileInformationClass,
-                      IN PVOID pBuffer,
-                      IN ULONG BufferLength);
+NTSTATUS vbsfNtCloseFileHandle(PMRX_VBOX_NETROOT_EXTENSION pNetRootExtension,
+                               PMRX_VBOX_FOBX pVBoxFobx);
 NTSTATUS vbsfNtRemove(IN PRX_CONTEXT RxContext);
-
 void     vbsfNtCopyInfoToLegacy(PMRX_VBOX_FOBX pVBoxFobx, PCSHFLFSOBJINFO pInfo);
-
 NTSTATUS vbsfNtVBoxStatusToNt(int vrc);
 PVOID    vbsfNtAllocNonPagedMem(ULONG ulSize);