Changeset 69596 in vbox

Timestamp:

Nov 6, 2017 1:02:12 PM (7 years ago)

Author:

vboxsync

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

118948

Message:

fatvfs.cpp: Split dir and file structures into shared and handle specific parts, like the ifsvfs does. Docs and nits.

File:

• trunk/src/VBox/Runtime/common/fs/fatvfs.cpp (modified) (16 diffs)

trunk/src/VBox/Runtime/common/fs/fatvfs.cpp

@@ -123 +123 @@
     RTLISTANCHOR    ListParts;
 } RTFSFATCHAIN;
+/** Pointer to a FAT chain. */
 typedef RTFSFATCHAIN *PRTFSFATCHAIN;
+/** Pointer to a const FAT chain. */
 typedef RTFSFATCHAIN const *PCRTFSFATCHAIN;
 
 
 /**
- * FAT file system object (common part to files and dirs).
+ * FAT file system object (common part to files and dirs (shared)).
  */
 typedef struct RTFSFATOBJ
@@ -160 +162 @@
     bool                fMaybeDirtyDirEnt;
 } RTFSFATOBJ;
+/** Poitner to a FAT file system object. */
 typedef RTFSFATOBJ *PRTFSFATOBJ;
 
+/**
+ * Shared FAT file data.
+ */
 typedef struct RTFSFATFILESHRD
 {
@@ -167 +173 @@
     RTFSFATOBJ          Core;
 } RTFSFATFILESHRD;
+/** Pointer to shared FAT file data. */
 typedef RTFSFATFILESHRD *PRTFSFATFILESHRD;
 
 
+/**
+ * Per handle data for a FAT file.
+ */
 typedef struct RTFSFATFILE
 {
@@ -177 +187 @@
     uint32_t            offFile;
 } RTFSFATFILE;
+/** Pointer to the per handle data of a FAT file. */
 typedef RTFSFATFILE *PRTFSFATFILE;
 
 
 /**
- * FAT directory.
+ * FAT shared directory structure.
  *
  * We work directories in one of two buffering modes.  If there are few entries
@@ -242 +253 @@
     } u;
 } RTFSFATDIRSHRD;
-/** Pointer to a FAT directory instance. */
+/** Pointer to a shared FAT directory instance. */
 typedef RTFSFATDIRSHRD *PRTFSFATDIRSHRD;
 
 
 /**
- * FAT directory.
+ * The per handle FAT directory data.
  */
 typedef struct RTFSFATDIR
@@ -256 +267 @@
     uint32_t            offDir;
 } RTFSFATDIR;
-/** Pointer to a FAT directory instance. */
+/** Pointer to a per handle FAT directory data. */
 typedef RTFSFATDIR *PRTFSFATDIR;
 
@@ -387 +398 @@
     /** The size of the root directory, rounded up to the nearest sector size. */
     uint32_t        cbRootDir;
-    /** The root directory instance data. */
+    /** The root directory data (shared). */
     PRTFSFATDIRSHRD pRootDir;
 
@@ -1566 +1577 @@
 
 /**
- * @interface_method_impl{RTVFSOBJOPS,pfnClose}
- */
-static DECLCALLBACK(int) rtFsFatFile_Close(void *pvThis)
-{
-    PRTFSFATFILE pThis = (PRTFSFATFILE)pvThis;
-    LogFlow(("rtFsFatFile_Close(%p/%p)\n", pThis, pThis->pShared));
-
-    PRTFSFATFILESHRD pShared = pThis->pShared;
-    pThis->pShared = NULL;
-
-    int rc = VINF_SUCCESS;
-    if (pShared)
-    {
-        if (ASMAtomicDecU32(&pShared->Core.cRefs) == 0)
-        {
-            LogFlow(("rtFsFatFile_Close: Destroying shared structure %p\n", pShared));
-            rc = rtFsFatObj_Close(&pShared->Core);
-            RTMemFree(pShared);
-        }
-        else
-            rc = rtFsFatObj_FlushMetaData(&pShared->Core);
-    }
-    return rc;
-}
-
-
-/**
  * Worker for rtFsFatFile_QueryInfo and rtFsFatDir_QueryInfo
  */
@@ -1640 +1624 @@
 
 /**
+ * Worker for rtFsFatFile_SetMode and rtFsFatDir_SetMode.
+ */
+static int rtFsFatObj_SetMode(PRTFSFATOBJ pThis, RTFMODE fMode, RTFMODE fMask)
+{
+#if 0
+    if (fMask != ~RTFS_TYPE_MASK)
+    {
+        fMode |= ~fMask & ObjInfo.Attr.fMode;
+    }
+#else
+    RT_NOREF(pThis, fMode, fMask);
+    return VERR_NOT_IMPLEMENTED;
+#endif
+}
+
+
+/**
+ * Worker for rtFsFatFile_SetTimes and rtFsFatDir_SetTimes.
+ */
+static int rtFsFatObj_SetTimes(PRTFSFATOBJ pThis, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
+                               PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
+{
+#if 0
+    PRTFSFATFILE pThis = (PRTFSFATFILE)pvThis;
+#else
+    RT_NOREF(pThis, pAccessTime, pModificationTime, pChangeTime, pBirthTime);
+    return VERR_NOT_IMPLEMENTED;
+#endif
+}
+
+
+
+
+/**
+ * @interface_method_impl{RTVFSOBJOPS,pfnClose}
+ */
+static DECLCALLBACK(int) rtFsFatFile_Close(void *pvThis)
+{
+    PRTFSFATFILE pThis = (PRTFSFATFILE)pvThis;
+    LogFlow(("rtFsFatFile_Close(%p/%p)\n", pThis, pThis->pShared));
+
+    PRTFSFATFILESHRD pShared = pThis->pShared;
+    pThis->pShared = NULL;
+
+    int rc = VINF_SUCCESS;
+    if (pShared)
+    {
+        if (ASMAtomicDecU32(&pShared->Core.cRefs) == 0)
+        {
+            LogFlow(("rtFsFatFile_Close: Destroying shared structure %p\n", pShared));
+            rc = rtFsFatObj_Close(&pShared->Core);
+            RTMemFree(pShared);
+        }
+        else
+            rc = rtFsFatObj_FlushMetaData(&pShared->Core);
+    }
+    return rc;
+}
+
+
+/**
  * @interface_method_impl{RTVFSOBJOPS,pfnQueryInfo}
  */
@@ -1647 +1692 @@
     return rtFsFatObj_QueryInfo(&pThis->pShared->Core, pObjInfo, enmAddAttr);
 }
-
 
 
@@ -1949 +1993 @@
  * @interface_method_impl{RTVFSOBJSETOPS,pfnMode}
  */
-static DECLCALLBACK(int) rtFsFatObj_SetMode(void *pvThis, RTFMODE fMode, RTFMODE fMask)
-{
-#if 0
+static DECLCALLBACK(int) rtFsFatFile_SetMode(void *pvThis, RTFMODE fMode, RTFMODE fMask)
+{
     PRTFSFATFILE pThis = (PRTFSFATFILE)pvThis;
-    if (fMask != ~RTFS_TYPE_MASK)
-    {
-        fMode |= ~fMask & ObjInfo.Attr.fMode;
-    }
-#else
-    RT_NOREF(pvThis, fMode, fMask);
-    return VERR_NOT_IMPLEMENTED;
-#endif
+    return rtFsFatObj_SetMode(&pThis->pShared->Core, fMode, fMask);
 }
 
@@ -1967 +2003 @@
  * @interface_method_impl{RTVFSOBJSETOPS,pfnSetTimes}
  */
-static DECLCALLBACK(int) rtFsFatObj_SetTimes(void *pvThis, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
-                                             PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
-{
-#if 0
+static DECLCALLBACK(int) rtFsFatFile_SetTimes(void *pvThis, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
+                                              PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
+{
     PRTFSFATFILE pThis = (PRTFSFATFILE)pvThis;
-#else
-    RT_NOREF(pvThis, pAccessTime, pModificationTime, pChangeTime, pBirthTime);
-    return VERR_NOT_IMPLEMENTED;
-#endif
+    return rtFsFatObj_SetTimes(&pThis->pShared->Core, pAccessTime, pModificationTime, pChangeTime, pBirthTime);
 }
 
@@ -1982 +2014 @@
  * @interface_method_impl{RTVFSOBJSETOPS,pfnSetOwner}
  */
-static DECLCALLBACK(int) rtFsFatObj_SetOwner(void *pvThis, RTUID uid, RTGID gid)
+static DECLCALLBACK(int) rtFsFatFile_SetOwner(void *pvThis, RTUID uid, RTGID gid)
 {
     RT_NOREF(pvThis, uid, gid);
@@ -2068 +2100 @@
         RTVFSOBJSETOPS_VERSION,
         RT_OFFSETOF(RTVFSFILEOPS, Stream.Obj) - RT_OFFSETOF(RTVFSFILEOPS, ObjSet),
-        rtFsFatObj_SetMode,
-        rtFsFatObj_SetTimes,
-        rtFsFatObj_SetOwner,
+        rtFsFatFile_SetMode,
+        rtFsFatFile_SetTimes,
+        rtFsFatFile_SetOwner,
         RTVFSOBJSETOPS_VERSION
     },
@@ -3488 +3520 @@
 
 /**
+ * @interface_method_impl{RTVFSOBJSETOPS,pfnMode}
+ */
+static DECLCALLBACK(int) rtFsFatDir_SetMode(void *pvThis, RTFMODE fMode, RTFMODE fMask)
+{
+    PRTFSFATDIR pThis = (PRTFSFATDIR)pvThis;
+    return rtFsFatObj_SetMode(&pThis->pShared->Core, fMode, fMask);
+}
+
+
+/**
+ * @interface_method_impl{RTVFSOBJSETOPS,pfnSetTimes}
+ */
+static DECLCALLBACK(int) rtFsFatDir_SetTimes(void *pvThis, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
+                                             PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
+{
+    PRTFSFATDIR pThis = (PRTFSFATDIR)pvThis;
+    return rtFsFatObj_SetTimes(&pThis->pShared->Core, pAccessTime, pModificationTime, pChangeTime, pBirthTime);
+}
+
+
+/**
+ * @interface_method_impl{RTVFSOBJSETOPS,pfnSetOwner}
+ */
+static DECLCALLBACK(int) rtFsFatDir_SetOwner(void *pvThis, RTUID uid, RTGID gid)
+{
+    RT_NOREF(pvThis, uid, gid);
+    return VERR_NOT_SUPPORTED;
+}
+
+
+/**
  * @interface_method_impl{RTVFSOBJOPS,pfnTraversalOpen}
  */
@@ -3738 +3801 @@
         RTVFSOBJSETOPS_VERSION,
         RT_OFFSETOF(RTVFSDIROPS, Obj) - RT_OFFSETOF(RTVFSDIROPS, ObjSet),
-        rtFsFatObj_SetMode,
-        rtFsFatObj_SetTimes,
-        rtFsFatObj_SetOwner,
+        rtFsFatDir_SetMode,
+        rtFsFatDir_SetTimes,
+        rtFsFatDir_SetOwner,
         RTVFSOBJSETOPS_VERSION
     },