Changeset 98709 in vbox for trunk/include

Timestamp:

Feb 24, 2023 8:49:40 AM (2 years ago)

Author:

vboxsync

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

156009

Message:

Guest Control: Implemented directory handling / walking as non-toolbox variants. bugref:9783

Location:

trunk/include/VBox

Files:

• GuestHost/GuestControl.h (modified) (3 diffs)
• HostServices/GuestControlSvc.h (modified) (5 diffs)

trunk/include/VBox/GuestHost/GuestControl.h

@@ -402 +402 @@
 typedef const GSTCTLFSOBJATTR *PCGSTCTLFSOBJATTR;
 
-/** @name GSTCTL_QUERYINFO_F_XXX - Generic flags for querying guest file system information.
+/** @name GSTCTL_PATH_F_XXX - Generic flags for querying guest file system information.
  * @{ */
 /** No guest stat flags specified. */
-#define GSTCTL_QUERYINFO_F_NONE               UINT32_C(0)
+#define GSTCTL_PATH_F_NONE               UINT32_C(0)
 /** Last component: Work on the link. */
-#define GSTCTL_QUERYINFO_F_ON_LINK            RT_BIT_32(0)
+#define GSTCTL_PATH_F_ON_LINK            RT_BIT_32(0)
 /** Last component: Follow if link. */
-#define GSTCTL_QUERYINFO_F_FOLLOW_LINK        RT_BIT_32(1)
+#define GSTCTL_PATH_F_FOLLOW_LINK        RT_BIT_32(1)
 /** Don't allow symbolic links as part of the path. */
-#define GSTCTL_QUERYINFO_F_NO_SYMLINKS        RT_BIT_32(2)
-/** GSTCTL_QUERYINFO_F_XXX flag valid mask. */
-#define GSTCTL_QUERYINFO_F_VALID_MASK         UINT32_C(0x00000007)
+#define GSTCTL_PATH_F_NO_SYMLINKS        RT_BIT_32(2)
+/** GSTCTL_PATH_F_XXX flag valid mask. */
+#define GSTCTL_PATH_F_VALID_MASK         UINT32_C(0x00000007)
 /** @} */
 
@@ -443 +443 @@
 /** @name GSTCTLDIR_F_XXX - Directory flags for HOST_MSG_DIR_OPEN.
  * @{ */
+/** No directory open flags specified. */
+#define GSTCTLDIR_F_NONE            UINT32_C(0)
 /** Don't allow symbolic links as part of the path.
  * @remarks this flag is currently not implemented and will be ignored. */
@@ -532 +534 @@
 typedef GSTCTLDIRENTRYEX const *PCGSTCTLDIRENTRYEX;
 
+/** The maximum size (in bytes) of a GSTCTLDIRENTRYEX (includes dynamic szName[pDirEntry->cbName + 1]). */
+#define GSTCTL_DIRENTRY_MAX_SIZE    (sizeof(GSTCTLDIRENTRYEX) + RTPATH_MAX)
+
 } /* namespace guestControl */
 

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -966 +966 @@
     /** Additional file system attributes to lookup (GSTCTLFSOBJATTRADD). */
     HGCMFunctionParameter add_attributes;
-    /** Flags (GSTCTL_QUERYINFO_F_XXX). */
+    /** Flags (GSTCTL_PATH_F_XXX). */
     HGCMFunctionParameter flags;
 } HGCMMsgFsQueryInfo;
@@ -1029 +1029 @@
     /** Path of directory to open. */
     HGCMFunctionParameter path;
-    /** Filter string to use (wildcard style). */
+    /** Filter type to use when walking the directory (GSTCTLDIRFILTER). */
     HGCMFunctionParameter filter;
-    /** Filter type to use when walking the directory (GSTCTLDIRFILTER). */
-    HGCMFunctionParameter filter_type;
     /** Directory open flags (GSTCTLDIR_F_XXX). */
     HGCMFunctionParameter flags;
@@ -1059 +1057 @@
     /** Handle of directory listing to read the next entry for. */
     HGCMFunctionParameter handle;
-    /** Custom directory entry size (in bytes) to use. */
-    HGCMFunctionParameter entry_size;
+    /** Maximum directory entry size (in bytes) to use.
+     *  @sa GSTCTL_DIRENTRY_MAX_SIZE */
+    HGCMFunctionParameter max_entry_size;
     /** Additional directory attributes to use (GSTCTLFSOBJATTRADD). */
     HGCMFunctionParameter add_attributes;
-    /** Directory reading flags. */
+    /** Directory reading flags.
+     *  GSTCTL_PATH_F_ON_LINK or GSTCTL_PATH_F_FOLLOW_LINK. */
     HGCMFunctionParameter flags;
 } HGCMMsgDirRead;
@@ -1708 +1708 @@
 
 /**
- * General guest directory notification callback.
- */
-typedef struct CALLBACKDATA_DIR_NOTIFY
+ * General guest file notification callback.
+ */
+typedef struct CALLBACKDATA_FILE_NOTIFY
 {
     /** Callback data header. */
@@ -1722 +1722 @@
         struct
         {
-            /** Pointer to directory information. */
-            PGSTCTLFSOBJINFO pObjInfo;
-        } info;
-        struct
-        {
-            /** Guest directory handle. */
-            uint32_t uHandle;
-        } open;
-        /** Note: Close does not have any additional data (yet). */
-        struct
-        {
-            /** Size (in bytes) of directory entry information. */
-            uint32_t          cbEntry;
-            /** Pointer to directory entry information. */
-            GSTCTLDIRENTRYEX *pEntry;
-        } read;
-    } u;
-} CALLBACKDATA_DIR_NOTIFY, *PCALLBACKDATA_DIR_NOTIFY;
-
-/**
- * General guest file notification callback.
- */
-typedef struct CALLBACKDATA_FILE_NOTIFY
-{
-    /** Callback data header. */
-    CALLBACKDATA_HEADER hdr;
-    /** Notification type. */
-    uint32_t uType;
-    /** IPRT result of overall operation. */
-    uint32_t rc;
-    union
-    {
-        struct
-        {
             /** Guest file handle. */
             uint32_t uHandle;