Changeset 69757 in vbox

Timestamp:

Nov 19, 2017 3:15:36 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

119157

Message:

iprt/dir.h: Added RTDirReadExA and RTDirReadExAFree for avoiding duplicating buffer management everywhere.

Location:

trunk

Files:

• include/iprt/dir.h (modified) (1 diff)
• include/iprt/mangling.h (modified) (1 diff)
• src/VBox/Runtime/r3/dir.cpp (modified) (1 diff)

trunk/include/iprt/dir.h

@@ -448 +448 @@
 
 /**
+ * Wrapper around RTDirReadEx that does the directory entry buffer handling.
+ *
+ * Call RTDirReadExAFree to free the buffers allocated by this function.
+ *
+ * @returns IPRT status code, see RTDirReadEx() for details.
+ *
+ * @param   hDir        Handle to the open directory.
+ * @param   ppDirEntry  Pointer to the directory entry pointer.  Initialize this
+ *                      to NULL before the first call.
+ * @param   pcbDirEntry Where the API caches the allocation size.  Set this to
+ *                      zero before the first call.
+ * @param   enmAddAttr  See RTDirReadEx.
+ * @param   fFlags      See RTDirReadEx.
+ */
+RTDECL(int) RTDirReadExA(RTDIR hDir, PRTDIRENTRYEX *ppDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
+
+/**
+ * Frees the buffer allocated by RTDirReadExA.
+ *
+ * @param   ppDirEntry  Pointer to the directory entry pointer.
+ * @param   pcbDirEntry Where the API caches the allocation size.
+ */
+RTDECL(void) RTDirReadExAFree(PRTDIRENTRYEX *ppDirEntry, size_t *pcbDirEntry);
+
+/**
  * Resolves RTDIRENTRYTYPE_UNKNOWN values returned by RTDirRead.
  *

trunk/include/iprt/mangling.h

@@ -767 +767 @@
 # define RTDirRead                                      RT_MANGLER(RTDirRead)
 # define RTDirReadEx                                    RT_MANGLER(RTDirReadEx)
+# define RTDirReadExA                                   RT_MANGLER(RTDirReadExA)
+# define RTDirReadExAFree                               RT_MANGLER(RTDirReadExAFree)
 # define RTDirRemove                                    RT_MANGLER(RTDirRemove)
 # define RTDirRemoveRecursive                           RT_MANGLER(RTDirRemoveRecursive)

trunk/src/VBox/Runtime/r3/dir.cpp

@@ -795 +795 @@
 }
 
+
+RTDECL(int) RTDirReadExA(RTDIR hDir, PRTDIRENTRYEX *ppDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAddAttr, uint32_t fFlags)
+{
+    PRTDIRENTRYEX pDirEntry  = *ppDirEntry;
+    size_t        cbDirEntry = *pcbDirEntry;
+    if (pDirEntry != NULL && cbDirEntry >= sizeof(RTDIRENTRYEX))
+    { /* likely */ }
+    else
+    {
+        Assert(pDirEntry == NULL);
+        Assert(cbDirEntry == 0);
+
+        cbDirEntry  = RT_ALIGN_Z(sizeof(RTDIRENTRYEX), 16);
+        *ppDirEntry = pDirEntry = (PRTDIRENTRYEX)RTMemTmpAlloc(cbDirEntry);
+        if (pDirEntry)
+            *pcbDirEntry = cbDirEntry;
+        else
+        {
+            *pcbDirEntry = 0;
+            return VERR_NO_TMP_MEMORY;
+        }
+    }
+
+    for (;;)
+    {
+        int rc = RTDirReadEx(hDir, pDirEntry, &cbDirEntry, enmAddAttr, fFlags);
+        if (rc != VERR_BUFFER_OVERFLOW)
+            return rc;
+
+        /* Grow the buffer. */
+        RTMemTmpFree(pDirEntry);
+        cbDirEntry = RT_MAX(RT_ALIGN_Z(cbDirEntry, 64), *pcbDirEntry + 64);
+        *ppDirEntry = pDirEntry = (PRTDIRENTRYEX)RTMemTmpAlloc(cbDirEntry);
+        if (pDirEntry)
+            *pcbDirEntry = cbDirEntry;
+        else
+        {
+            *pcbDirEntry = 0;
+            return VERR_NO_TMP_MEMORY;
+        }
+    }
+}
+
+
+RTDECL(void) RTDirReadExAFree(PRTDIRENTRYEX *ppDirEntry, size_t *pcbDirEntry)
+{
+    PRTDIRENTRYEX pDirEntry = *ppDirEntry;
+    if (pDirEntry != NULL && *pcbDirEntry >= sizeof(*pcbDirEntry))
+        RTMemTmpFree(pDirEntry);
+    else
+    {
+        Assert(pDirEntry == NULL);
+        Assert(*pcbDirEntry == 0);
+    }
+    *ppDirEntry  = NULL;
+    *pcbDirEntry = 0;
+}
+