Changeset 99262 in vbox for trunk/include

Timestamp:

Apr 3, 2023 3:17:07 PM (20 months ago)

Author:

vboxsync

Message:

Guest Control: Implements IGuestSession::fsQueryInfo() and IGuestSession::fsQueryFreeSpace(). bugref:10414

Location:

trunk/include/VBox

Files:

• GuestHost/GuestControl.h (modified) (2 diffs)
• HostServices/GuestControlSvc.h (modified) (7 diffs)
• VBoxGuestLib.h (modified) (2 diffs)

trunk/include/VBox/GuestHost/GuestControl.h

@@ -44 +44 @@
 
 #include <iprt/time.h>
+#include <iprt/path.h>
 #include <iprt/types.h>
 
@@ -266 +267 @@
     INPUT_STS_OVERFLOW = 30
 };
+
+/** @name Guest filesystem flags.
+ *
+ * @{
+ */
+/** No guest file system flags set. */
+#define GSTCTLFSINFO_F_NONE                         UINT32_C(0)
+/** If the filesystem is remote or not. */
+#define GSTCTLFSINFO_F_IS_REMOTE                    RT_BIT(0)
+/** If the filesystem is case sensitive or not. */
+#define GSTCTLFSINFO_F_IS_CASE_SENSITIVE            RT_BIT(1)
+/** If the filesystem is mounted read only or not. */
+#define GSTCTLFSINFO_F_IS_READ_ONLY                 RT_BIT(2)
+/** If the filesystem is compressed or not. */
+#define GSTCTLFSINFO_F_IS_COMPRESSED                RT_BIT(3)
+/** Valid mask. */
+#define GSTCTLFSINFO_F_VALID_MASK                   0xF
+/** @} */
+
+/** @name Guest filesystem feature flags.
+ *
+ * @{
+ */
+/** No guest file system feature flags set. */
+#define GSTCTLFSINFO_FEATURE_F_NONE                 UINT32_C(0)
+/** If the filesystem can handle Unicode or not. */
+#define GSTCTLFSINFO_FEATURE_F_UNICODE              RT_BIT(0)
+/** If the filesystem supports sparse files or not. */
+#define GSTCTLFSINFO_FEATURE_F_SPARSE_FILES         RT_BIT(1)
+/** If the filesystem features compression of individual files or not. */
+#define GSTCTLFSINFO_FEATURE_F_FILE_COMPRESSION     RT_BIT(2)
+/** Valid mask. */
+#define GSTCTLFSINFO_FEATURE_F_VALID_MASK           0x7
+/** @} */
+
+/** Maximum length (in characters) of a guest file name. */
+#define GSTCTL_FS_NAME_MAX                          255
+/** Maximum length (in characters) of a guest file label. */
+#define GSTCTL_FS_LABEL_MAX                         255
+/** Maximum length (in characters) of a guest filesystem mount point. */
+#define GSTCTL_FS_MOUNTPOINT_MAX                    RTPATH_MAX
+
+/**
+ * Guest filesystem information.
+ */
+#pragma pack(1)
+typedef struct GSTCTLFSINFO
+{
+    /** Remaining free space (in bytes) of the filesystem. */
+    uint64_t cbFree;
+    /** Total space (in bytes) of the filesystem. */
+    uint64_t cbTotalSize;
+    /** Block size (in bytes) of the filesystem. */
+    uint32_t cbBlockSize;
+    /** Sector size (in bytes) of the filesystem. */
+    uint32_t cbSectorSize;
+    /** Serial number of the filesystem. */
+    uint32_t uSerialNumber;
+    /** Flags (of type GSTCTLFSINFO_F_XXX). */
+    uint32_t fFlags;
+    /** Feature flags (of type GSTCTLFSINFO_FEATURE_F_XXX). */
+    uint32_t fFeatures;
+    /** The maximum size (in characters) of a filesystem object name. */
+    uint32_t cMaxComponent;
+    /** Name of the filesystem type. */
+    char     szName[GSTCTL_FS_NAME_MAX];
+    /** Label of the filesystem. */
+    char     szLabel[GSTCTL_FS_LABEL_MAX];
+    /** Size (in bytes) of \a szMountpoint. */
+    uint16_t cbMountpoint;
+    /** Mount point of the filesystem.
+     *  Will be dynamically allocated, based on \a cbMountpoint. */
+    char     szMountpoint[1];
+} GSTCTLFSINFO;
+#pragma pack()
+AssertCompileSize(GSTCTLFSINFO, 553);
+/** Pointer to a guest filesystem structure. */
+typedef GSTCTLFSINFO *PGSTCTLFSINFO;
+/** Pointer to a const guest filesystem structure. */
+typedef const GSTCTLFSINFO *PCGSTCTLFSINFO;
 
 /**

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -268 +268 @@
      */
     HOST_MSG_FS_CREATE_TEMP = 335,
+    /**
+     * Retrieves information about a guest file system.
+     */
+    HOST_MSG_FS_QUERY_INFO = 336,
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
     /** Blow the type up to 32-bits. */
@@ -318 +322 @@
         RT_CASE_RET_STR(HOST_MSG_FS_OBJ_QUERY_INFO);
         RT_CASE_RET_STR(HOST_MSG_FS_CREATE_TEMP);
+        RT_CASE_RET_STR(HOST_MSG_FS_QUERY_INFO);
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
         RT_CASE_RET_STR(HOST_MSG_32BIT_HACK);
@@ -772 +777 @@
 {
     /** Unknown fs notification type; do not use. */
-    GUEST_FS_NOTIFYTYPE_UNKNOWN     = 0,
+    GUEST_FS_NOTIFYTYPE_UNKNOWN        = 0,
+    /** Temporary directory creation notification from the guest.
+     *  @since 7.1 */
+    GUEST_FS_NOTIFYTYPE_CREATE_TEMP    = 1,
+    /** File system object query information notification from the guest.
+     *  @since 7.1 */
+    GUEST_FS_NOTIFYTYPE_QUERY_OBJ_INFO = 2,
     /** File system query information notification from the guest.
      *  @since 7.1 */
-    GUEST_FS_NOTIFYTYPE_QUERY_INFO  = 2,
-    /** Temporary directory creation notification from the guest.
-     *  @since 7.1 */
-    GUEST_FS_NOTIFYTYPE_CREATE_TEMP = 1
+    GUEST_FS_NOTIFYTYPE_QUERY_INFO     = 3
 };
 
@@ -968 +976 @@
     HGCMFunctionParameter mode;
 } HGCMMsgFsCreateTemp;
+
+/**
+ * Queries information of a file system on the guest.
+ */
+typedef struct HGCMMsgFsQueryInfo
+{
+    VBGLIOCHGCMCALL hdr;
+    /** Context ID. */
+    HGCMFunctionParameter context;
+    /** Path to query file system information for. */
+    HGCMFunctionParameter path;
+} HGCMMsgFsQueryInfo;
 
 /**
@@ -1618 +1638 @@
     {
         /**
-         * Parameters used for \a type GUEST_FS_NOTIFYTYPE_QUERY_INFO.
+         * Parameters used for \a type GUEST_FS_NOTIFYTYPE_CREATE_TEMP.
+         *
+         * @since 7.1
+         */
+        struct
+        {
+            /** The create temporary file / directory when \a rc
+             *  indicates success. */
+            HGCMFunctionParameter path;
+        } createtemp;
+        /**
+         * Parameters used for \a type GUEST_FS_NOTIFYTYPE_QUERY_OBJ_INFO.
          *
          * @since 7.1
@@ -1633 +1664 @@
              *  the first group always is the primary group. */
             HGCMFunctionParameter groups;
-        } queryinfo;
+        } queryobjinfo;
         /**
-         * Parameters used for \a type GUEST_FS_NOTIFYTYPE_CREATE_TEMP.
+         * Parameters used for \a type GUEST_FS_NOTIFYTYPE_QUERY_INFO.
          *
          * @since 7.1
@@ -1641 +1672 @@
         struct
         {
-            /** The create temporary file / directory when \a rc
-             *  indicates success. */
-            HGCMFunctionParameter path;
-        } createtemp;
+            /** File system object information (GSTCTLFSINFO). */
+            HGCMFunctionParameter fs_info;
+        } queryinfo;
     } u;
 } HGCMReplyFsNotify;

trunk/include/VBox/VBoxGuestLib.h

@@ -1098 +1098 @@
  * @{
  */
+VBGLR3DECL(int) VbglR3GuestCtrlFsGetCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszTemplate, uint32_t cbTemplate, char *pszPath, uint32_t cbPath, uint32_t *pfFlags, uint32_t *pfMode);
+VBGLR3DECL(int) VbglR3GuestCtrlFsGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath);
+/** @} */
+
+/** @name Guest Control file system object functions.
+ * @{
+ */
 VBGLR3DECL(int) VbglR3GuestCtrlFsObjGetQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszPath, uint32_t cbPath, GSTCTLFSOBJATTRADD *penmAddAttrib, uint32_t *pfFlags);
-VBGLR3DECL(int) VbglR3GuestCtrlFsGetCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, char *pszTemplate, uint32_t cbTemplate, char *pszPath, uint32_t cbPath, uint32_t *pfFlags, uint32_t *pfMode);
 /** @} */
 #  endif
+
 VBGLR3DECL(int) VbglR3GuestCtrlGetShutdown(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t *pfAction);
 /* Guest process execution. */
@@ -1180 +1187 @@
  * @{
  */
+VBGLR3DECL(int) VbglR3GuestCtrlFsCbCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, const char *pszPath);
+VBGLR3DECL(int) VbglR3GuestCtrlFsCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSINFO pFsInfo, uint32_t cbFsInfo);
+/** @} */
+
+/** @name Guest Control file system object callbacks.
+ * @{
+ */
 VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfoEx(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pObjInfo, const char *pszUser, const char *pszGroups);
 VBGLR3DECL(int) VbglR3GuestCtrlFsObjCbQueryInfo(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, PGSTCTLFSOBJINFO pObjInfo);
-VBGLR3DECL(int) VbglR3GuestCtrlFsCbCreateTemp(PVBGLR3GUESTCTRLCMDCTX pCtx, uint32_t uRc, const char *pszPath);
 /** @} */
 #  endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */