Changeset 99085 in vbox for trunk/include/VBox/HostServices/GuestControlSvc.h

Timestamp:

Mar 21, 2023 12:15:00 PM (2 years ago)

Author:

vboxsync

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

156450

Message:

Guest Control: Added directory listing support via IDirectory::list(). Added (randomized) testcase support for it. bugref:9783

File:

• trunk/include/VBox/HostServices/GuestControlSvc.h (modified) (8 diffs)

trunk/include/VBox/HostServices/GuestControlSvc.h

@@ -232 +232 @@
      */
     HOST_MSG_DIR_CREATE = 314,
+    /**
+     * Lists one or multiple directory entries at once.
+     *
+     * @since   7.1
+     */
+    HOST_MSG_DIR_LIST = 315,
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
     /**
@@ -302 +308 @@
         RT_CASE_RET_STR(HOST_MSG_DIR_REWIND);
         RT_CASE_RET_STR(HOST_MSG_DIR_CREATE);
+        RT_CASE_RET_STR(HOST_MSG_DIR_LIST);
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
         RT_CASE_RET_STR(HOST_MSG_DIR_REMOVE);
@@ -729 +736 @@
     /** Guest directory was rewind. */
     GUEST_DIR_NOTIFYTYPE_REWIND = 22,
+    /** Guest directory listing. */
+    GUEST_DIR_NOTIFYTYPE_LIST = 23,
 #endif
     /** Information about an open guest directory. */
@@ -1092 +1101 @@
     HGCMFunctionParameter flags;
 } HGCMMsgDirCreate;
+
+/**
+ * Lists the entries of a directory on the guest.
+ */
+typedef struct HGCMMsgDirList
+{
+    VBGLIOCHGCMCALL hdr;
+    /** Context ID. */
+    HGCMFunctionParameter context;
+    /** Handle of directory listing to list. */
+    HGCMFunctionParameter handle;
+    /** Number of entries to read at once.
+     *  Specify UINT32_MAX to read as much as possible. 0 is not allowed. */
+    HGCMFunctionParameter num_entries;
+    /** Listing flags (GSTCTL_DIRLIST_F_XXX). */
+    HGCMFunctionParameter flags;
+} HGCMMsgDirList;
 #endif /* VBOX_WITH_GSTCTL_TOOLBOX_AS_CMDS */
 
@@ -1528 +1554 @@
     {
         /**
-         * Parameters used for \a type GUEST_DIR_NOTIFYTYPE_OPEN.
+         * Parameters used for \a reply_hdr.type GUEST_DIR_NOTIFYTYPE_OPEN.
          *
          * @since 7.1
@@ -1538 +1564 @@
         } open;
         /**
-         * Parameters used for \a type GUEST_DIR_NOTIFYTYPE_READ.
+         * Parameters used for \a reply_hdr.type GUEST_DIR_NOTIFYTYPE_READ.
          *
          * @since 7.1
@@ -1550 +1576 @@
             /** Resolved group IDs as a string.
              *
-             *  Multiple groups are delimited by "\r\n", whereas
+             *  Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR, whereas
              *  the first group always is the primary group. */
             HGCMFunctionParameter groups;
         } read;
+        /**
+         * Parameters used for \a reply_hdr.type GUEST_DIR_NOTIFYTYPE_LIST.
+         *
+         * @since 7.1
+         */
+        struct
+        {
+            /** Number of entries in \a buffer. */
+            HGCMFunctionParameter num_entries;
+            /** Buffer containing the GSTCTLDIRENTRYEX entries, immediately followed
+             *  by resolved user + groups as a string (empty strings if not resolved).
+             *
+             *  Only will be sent if \a num_entries > 0. */
+            HGCMFunctionParameter buffer;
+        } list;
     } u;
 } HGCMReplyDirNotify;
@@ -1582 +1623 @@
             /** Resolved group IDs as a string.
              *
-             *  Multiple groups are delimited by "\r\n", whereas
+             *  Multiple groups are delimited by GSTCTL_DIRENTRY_GROUPS_DELIMITER_STR, whereas
              *  the first group always is the primary group. */
             HGCMFunctionParameter groups;