Changeset 77681 in vbox

Timestamp:

Mar 13, 2019 3:26:52 PM (6 years ago)

Author:

vboxsync

Message:

IPRT: Adding an extended file open API that returns the action taken (opened, created, replaced, truncated) for addressing tickref:9276. Windows implementation only thus far.

Location:

trunk

Files:

• include/iprt/file.h (modified) (3 diffs)
• include/iprt/mangling.h (modified) (1 diff)
• src/VBox/Runtime/r3/win/fileio-win.cpp (modified) (7 diffs)
• src/VBox/Runtime/testcase/Makefile.kmk (modified) (2 diffs)
• src/VBox/Runtime/testcase/tstRTFileOpenEx-1.cpp (added)

trunk/include/iprt/file.h

@@ -140 +140 @@
 #define RTFILE_O_DENY_MASK              UINT32_C(0x000000f0)
 
-/** Action: Open an existing file (the default action). */
+/** Action: Open an existing file. */
 #define RTFILE_O_OPEN                   UINT32_C(0x00000700)
 /** Action: Create a new file or open an existing one. */
@@ -243 +243 @@
 
 
+/** Action taken by RTFileOpenEx. */
+typedef enum RTFILEACTION
+{
+    /** Invalid zero value.   */
+    RTFILEACTION_INVALID = 0,
+    /** Existing file was opened (returned by RTFILE_O_OPEN and
+     * RTFILE_O_OPEN_CREATE). */
+    RTFILEACTION_OPENED,
+    /** New file was created (returned by RTFILE_O_CREATE and
+     * RTFILE_O_OPEN_CREATE). */
+    RTFILEACTION_CREATED,
+    /** Existing file was replaced (returned by RTFILE_O_CREATE_REPLACE). */
+    RTFILEACTION_REPLACED,
+    /** Existing file was truncated (returned if RTFILE_O_TRUNCATE take effect). */
+    RTFILEACTION_TRUNCATED,
+    /** The file already exists (returned by RTFILE_O_CREATE on failure). */
+    RTFILEACTION_ALREADY_EXISTS,
+    /** End of valid values. */
+    RTFILEACTION_END,
+    /** Type size hack.   */
+    RTFILEACTION_32BIT_HACK = 0x7fffffff
+} RTFILEACTION;
+/** Pointer to action taken value (RTFileOpenEx).    */
+typedef RTFILEACTION *PRTFILEACTION;
+
+
 #ifdef IN_RING3
 /**
@@ -292 +318 @@
  */
 RTDECL(int)  RTFileOpenV(PRTFILE pFile, uint64_t fOpen, const char *pszFilenameFmt, va_list va) RT_IPRT_FORMAT_ATTR(3, 0);
+
+/**
+ * Open a file, extended version.
+ *
+ * @returns iprt status code.
+ * @param   pszFilename     Path to the file which is to be opened. (UTF-8)
+ * @param   fOpen           Open flags, i.e a combination of the RTFILE_O_* defines.
+ *                          The ACCESS, ACTION and DENY flags are mandatory!
+ * @param   phFile          Where to store the handle to the opened file.
+ * @param   penmActionTaken Where to return an indicator of which action was
+ *                          taken.  This is optional and it is recommended to
+ *                          pass NULL when not strictly needed as it adds
+ *                          complexity (slower) on posix systems.
+ */
+RTDECL(int)  RTFileOpenEx(const char *pszFilename, uint64_t fOpen, PRTFILE phFile, PRTFILEACTION penmActionTaken);
 
 /**

trunk/include/iprt/mangling.h

@@ -935 +935 @@
 # define RTFileOpen                                     RT_MANGLER(RTFileOpen)
 # define RTFileOpenBitBucket                            RT_MANGLER(RTFileOpenBitBucket)
+# define RTFileOpenEx                                   RT_MANGLER(RTFileOpenEx)
 # define RTFileOpenF                                    RT_MANGLER(RTFileOpenF)
 # define RTFileOpenV                                    RT_MANGLER(RTFileOpenV)

trunk/src/VBox/Runtime/r3/win/fileio-win.cpp

@@ -166 +166 @@
 RTR3DECL(int) RTFileOpen(PRTFILE pFile, const char *pszFilename, uint64_t fOpen)
 {
+    return RTFileOpenEx(pszFilename, fOpen, pFile, NULL);
+}
+
+
+RTDECL(int) RTFileOpenEx(const char *pszFilename, uint64_t fOpen, PRTFILE phFile, PRTFILEACTION penmActionTaken)
+{
     /*
      * Validate input.
      */
-    if (!pFile)
-    {
-        AssertMsgFailed(("Invalid pFile\n"));
-        return VERR_INVALID_PARAMETER;
-    }
-    *pFile = NIL_RTFILE;
-    if (!pszFilename)
-    {
-        AssertMsgFailed(("Invalid pszFilename\n"));
-        return VERR_INVALID_PARAMETER;
-    }
+    AssertReturn(phFile, VERR_INVALID_PARAMETER);
+    *phFile = NIL_RTFILE;
+    if (penmActionTaken)
+        *penmActionTaken = RTFILEACTION_INVALID;
+    AssertReturn(pszFilename, VERR_INVALID_PARAMETER);
 
     /*
@@ -208 +208 @@
             break;
         default:
-            AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
-            return VERR_INVALID_PARAMETER;
+            AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
     }
 
@@ -236 +235 @@
             RT_FALL_THRU();
         default:
-            AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
-            return VERR_INVALID_PARAMETER;
+            AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
     }
     if (dwCreationDisposition == TRUNCATE_EXISTING)
@@ -257 +255 @@
                 case RTFILE_O_READWRITE:     dwDesiredAccess |= FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
                 default:
-                    AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
-                    return VERR_INVALID_PARAMETER;
+                    AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
             }
     }
@@ -275 +272 @@
         case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READWRITE:dwShareMode = FILE_SHARE_DELETE; break;
         default:
-            AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
-            return VERR_INVALID_PARAMETER;
+            AssertMsgFailedReturn(("Impossible fOpen=%#llx\n", fOpen), VERR_INVALID_FLAGS);
     }
 
@@ -315 +311 @@
                                    dwFlagsAndAttributes,
                                    NULL);
+        DWORD const dwErr = GetLastError();
         if (hFile != INVALID_HANDLE_VALUE)
         {
-            bool fCreated = dwCreationDisposition == CREATE_ALWAYS
-                         || dwCreationDisposition == CREATE_NEW
-                         || (dwCreationDisposition == OPEN_ALWAYS && GetLastError() == 0);
-
             /*
-             * Turn off indexing of directory through Windows Indexing Service.
+             * Calculate the action taken value.
              */
-            if (    fCreated
-                &&  (fOpen & RTFILE_O_NOT_CONTENT_INDEXED))
-            {
+            RTFILEACTION enmActionTaken;
+            switch (dwCreationDisposition)
+            {
+                case CREATE_NEW:
+                    enmActionTaken = RTFILEACTION_CREATED;
+                    break;
+                case CREATE_ALWAYS:
+                    AssertMsg(dwErr == ERROR_ALREADY_EXISTS || dwErr == NO_ERROR, ("%u\n", dwErr));
+                    enmActionTaken = dwErr == ERROR_ALREADY_EXISTS ? RTFILEACTION_REPLACED : RTFILEACTION_CREATED;
+                    break;
+                case OPEN_EXISTING:
+                    enmActionTaken = RTFILEACTION_OPENED;
+                    break;
+                case OPEN_ALWAYS:
+                    AssertMsg(dwErr == ERROR_ALREADY_EXISTS || dwErr == NO_ERROR, ("%u\n", dwErr));
+                    enmActionTaken = dwErr == ERROR_ALREADY_EXISTS ? RTFILEACTION_OPENED : RTFILEACTION_CREATED;
+                    break;
+                case TRUNCATE_EXISTING:
+                    enmActionTaken = RTFILEACTION_TRUNCATED;
+                    break;
+                default:
+                    AssertMsgFailed(("%d %#x\n", dwCreationDisposition, dwCreationDisposition));
+                    enmActionTaken = RTFILEACTION_INVALID;
+                    break;
+            }
+
+            /*
+             * Turn off indexing of directory through Windows Indexing Service if
+             * we created a new file or replaced an existing one.
+             */
+            if (   (fOpen & RTFILE_O_NOT_CONTENT_INDEXED)
+                && (   enmActionTaken == RTFILEACTION_CREATED
+                    || enmActionTaken == RTFILEACTION_REPLACED) )
+            {
+                /** @todo there must be a way to do this via the handle! */
                 if (!SetFileAttributesW(pwszFilename, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED))
                     rc = RTErrConvertFromWin32(GetLastError());
             }
             /*
-             * Do we need to truncate the file?
+             * If RTFILEACTION_OPENED, we may need to truncate the file.
              */
-            else if (    !fCreated
-                     &&     (fOpen & (RTFILE_O_TRUNCATE | RTFILE_O_ACTION_MASK))
-                         == (RTFILE_O_TRUNCATE | RTFILE_O_OPEN_CREATE))
-            {
-                if (!SetEndOfFile(hFile))
+            else if (  (fOpen & (RTFILE_O_TRUNCATE | RTFILE_O_ACTION_MASK)) == (RTFILE_O_TRUNCATE | RTFILE_O_OPEN_CREATE)
+                     && enmActionTaken == RTFILEACTION_OPENED)
+            {
+                if (SetEndOfFile(hFile))
+                    enmActionTaken = RTFILEACTION_TRUNCATED;
+                else
                     rc = RTErrConvertFromWin32(GetLastError());
             }
+            if (penmActionTaken)
+                *penmActionTaken = enmActionTaken;
             if (RT_SUCCESS(rc))
             {
-                *pFile = (RTFILE)hFile;
-                Assert((HANDLE)*pFile == hFile);
+                *phFile = (RTFILE)hFile;
+                Assert((HANDLE)*phFile == hFile);
                 RTPathWinFree(pwszFilename);
                 return VINF_SUCCESS;
@@ -351 +379 @@
         }
         else
-            rc = RTErrConvertFromWin32(GetLastError());
+        {
+            if (   penmActionTaken
+                && dwCreationDisposition == CREATE_NEW
+                && dwErr == ERROR_FILE_EXISTS)
+                *penmActionTaken = RTFILEACTION_ALREADY_EXISTS;
+            rc = RTErrConvertFromWin32(dwErr);
+        }
         RTPathWinFree(pwszFilename);
     }

trunk/src/VBox/Runtime/testcase/Makefile.kmk

@@ -160 +160 @@
         tstRTNtPath-1 \
         ntGetTimerResolution \
-        tstRTDarwinMachKernel
+        tstRTDarwinMachKernel \
+        tstRTFileOpenEx-1
 
 PROGRAMS.linux += \
@@ -364 +365 @@
 tstRTFileModeStringToFlags_SOURCES = tstRTFileModeStringToFlags.cpp
 
+tstRTFileOpenEx-1_TEMPLATE = VBOXR3TSTEXE
+tstRTFileOpenEx-1_SOURCES = tstRTFileOpenEx-1.cpp
+
 tstFileAppendWin-1_TEMPLATE = VBOXR3TSTEXE
 tstFileAppendWin-1_SOURCES = tstFileAppendWin-1.cpp