Changeset 11041 in vbox

Timestamp:

Jul 31, 2008 6:00:42 PM (17 years ago)

Author:

vboxsync

Message:

Main: added guest property enumeration (currently only works when the machine is running)

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (2 diffs)
• MachineImpl.cpp (modified) (1 diff)
• SessionImpl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (9 diffs)
• include/ConsoleImpl.h (modified) (1 diff)
• include/SessionImpl.h (modified) (1 diff)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -84 +84 @@
 #ifdef VBOX_WITH_GUEST_PROPS
 # include <VBox/HostServices/GuestPropertySvc.h>
+# include <VBox/com/array.h>
 #endif
 
@@ -3645 +3646 @@
             tr ("Failed to call the VBoxGuestPropSvc service (%Rrc)"), vrc);
     return rc;
+#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
+}
+
+
+/**
+ * @note Temporarily locks this object for writing.
+ */
+HRESULT Console::enumerateGuestProperties (INPTR BSTR aPatterns,
+                                           ComSafeArrayOut(BSTR, aNames),
+                                           ComSafeArrayOut(BSTR, aValues),
+                                           ComSafeArrayOut(ULONG64, aTimestamps),
+                                           ComSafeArrayOut(BSTR, aFlags))
+{
+#if !defined (VBOX_WITH_GUEST_PROPS)
+    return E_NOTIMPL;
+#else
+    if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aNames))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aValues))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aTimestamps))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aFlags))
+        return E_POINTER;
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturnRC (autoCaller.rc());
+
+    /* protect mpVM (if not NULL) */
+    AutoVMCallerWeak autoVMCaller (this);
+    CheckComRCReturnRC (autoVMCaller.rc());
+
+    /* Note: validity of mVMMDev which is bound to uninit() is guaranteed by
+     * autoVMCaller, so there is no need to hold a lock of this */
+
+    using namespace guestProp;
+
+    VBOXHGCMSVCPARM parm[3];
+
+/*
+ * Set up the pattern parameter, translating the comma-separated list to a
+ * double-terminated zero-separated one.
+ */
+    Utf8Str Utf8PatternsIn = aPatterns;
+    if ((aPatterns != NULL) && Utf8PatternsIn.isNull())
+        return E_OUTOFMEMORY;
+    size_t cchPatterns = Utf8PatternsIn.length();
+    Utf8Str Utf8Patterns(cchPatterns + 2);  /* Double terminator */
+    if (Utf8Patterns.isNull())
+        return E_OUTOFMEMORY;
+    char *pszPatterns = Utf8Patterns.mutableRaw();
+    unsigned iPatterns = 0;
+    for (unsigned i = 0; i < cchPatterns; ++i)
+    {
+        char cIn = Utf8PatternsIn.raw()[i];
+        if ((cIn != ',') && (cIn != ' '))
+            pszPatterns[iPatterns] = cIn;
+        else if (cIn != ' ')
+            pszPatterns[iPatterns] = '\0';
+        if (cIn != ' ')
+            ++iPatterns;
+    }
+    pszPatterns[iPatterns] = '\0';
+    parm[0].type = VBOX_HGCM_SVC_PARM_PTR;
+    parm[0].u.pointer.addr = pszPatterns;
+    parm[0].u.pointer.size = cchPatterns + 1;
+
+/*
+ * Now things get slightly complicated.  Due to a race with the guest adding
+ * properties, there is no good way to know how much large a buffer to provide
+ * the service to enumerate into.  We choose a decent starting size and loop a
+ * few times, each time retrying with the size suggested by the service plus
+ * one Kb.
+ */
+    size_t cchBuf = 4096;
+    Utf8Str Utf8Buf;
+    int vrc = VERR_BUFFER_OVERFLOW;
+    for (unsigned i = 0; i < 10 && (VERR_BUFFER_OVERFLOW == vrc); ++i)
+    {
+        Utf8Buf.alloc(cchBuf + 1024);
+        if (Utf8Buf.isNull())
+            return E_OUTOFMEMORY;
+        parm[1].type = VBOX_HGCM_SVC_PARM_PTR;
+        parm[1].u.pointer.addr = Utf8Buf.mutableRaw();
+        parm[1].u.pointer.size = cchBuf + 1024;
+        vrc = mVMMDev->hgcmHostCall ("VBoxGuestPropSvc", ENUM_PROPS_HOST, 3,
+                                     &parm[0]);
+        if (parm[2].type != VBOX_HGCM_SVC_PARM_32BIT)
+            return setError (E_FAIL, tr ("Internal application error"));
+        cchBuf = parm[2].u.uint32;
+    }
+    if (VERR_BUFFER_OVERFLOW == vrc)
+        return setError (E_UNEXPECTED, tr ("Temporary failure due to guest activity, please retry"));
+
+/*
+ * Finally we have to unpack the data returned by the service into the safe
+ * arrays supplied by the caller.  We start by counting the number of entries.
+ */
+     const char *pszBuf
+         = reinterpret_cast<const char *>(parm[1].u.pointer.addr);
+     unsigned cEntries = 0;
+     /* The list is terminated by a zero-length string at the end of a set
+      * of four strings. */
+     for (size_t i = 0; strlen(pszBuf + i) != 0; )
+     {
+        /* We are counting sets of four strings. */
+        for (unsigned j = 0; j < 4; ++j)
+            i += strlen(pszBuf + i) + 1;
+        ++cEntries;
+     }
+
+/*
+ * And now we create the COM safe arrays and fill them in.
+ */
+     com::SafeArray <BSTR> names(cEntries);
+     com::SafeArray <BSTR> values(cEntries);
+     com::SafeArray <ULONG64> timestamps(cEntries);
+     com::SafeArray <BSTR> flags(cEntries);
+     size_t iBuf = 0;
+     /* Rely on the service to have formated the data correctly. */
+     for (unsigned i = 0; i < cEntries; ++i)
+     {
+        size_t cchName = strlen(pszBuf + iBuf);
+        Bstr(pszBuf + iBuf).detachTo(&names[i]);
+        iBuf += cchName + 1;
+        size_t cchValue = strlen(pszBuf + iBuf);
+        Bstr(pszBuf + iBuf).detachTo(&values[i]);
+        iBuf += cchValue + 1;
+        size_t cchTimestamp = strlen(pszBuf + iBuf);
+        timestamps[i] = RTStrToUInt64(pszBuf + iBuf);
+        iBuf += cchTimestamp + 1;
+        size_t cchFlags = strlen(pszBuf + iBuf);
+        Bstr(pszBuf + iBuf).detachTo(&flags[i]);
+        iBuf += cchFlags + 1;
+     }
+     names.detachTo(ComSafeArrayOutArg (aNames));
+     values.detachTo(ComSafeArrayOutArg (aValues));
+     timestamps.detachTo(ComSafeArrayOutArg (aTimestamps));
+     flags.detachTo(ComSafeArrayOutArg (aFlags));
+     return S_OK;
 #endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
 }

trunk/src/VBox/Main/MachineImpl.cpp

@@ -2856 +2856 @@
 }
 
-STDMETHODIMP Machine::EnumerateGuestProperties (INPTR BSTR aPattern, ComSafeArrayOut(BSTR, aKeys), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags))
-{
+STDMETHODIMP Machine::EnumerateGuestProperties (INPTR BSTR aPatterns, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags))
+{
+#if !defined (VBOX_WITH_GUEST_PROPS)
     return E_NOTIMPL;
+#else
+    if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aNames))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aValues))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aTimestamps))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aFlags))
+        return E_POINTER;
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    AutoReadLock alock (this);
+
+    using namespace guestProp;
+    HRESULT rc = E_FAIL;
+
+    switch (mData->mSession.mState)
+    {
+        case SessionState_Closed:
+        {
+            rc = setError (E_NOTIMPL,
+                     tr ("Not yet implemented for a non-running VM"));
+            break;
+        }
+        case SessionState_Open:
+        {
+            if (mData->mSession.mState != SessionState_Open)
+            {
+                rc = setError (E_FAIL,
+                    tr ("Session is not open (session state: %d)"),
+                    mData->mSession.mState);
+                break;
+            }
+
+            ComPtr <IInternalSessionControl> directControl =
+                mData->mSession.mDirectControl;
+
+            /* just be on the safe side when calling another process */
+            alock.unlock();
+
+            rc = directControl->EnumerateGuestProperties(aPatterns,
+                                                         ComSafeArrayOutArg(aNames),
+                                                         ComSafeArrayOutArg(aValues),
+                                                         ComSafeArrayOutArg(aTimestamps),
+                                                         ComSafeArrayOutArg(aFlags));
+            break;
+        }
+        default:
+            rc = setError (E_FAIL,
+                tr ("Session is currently transitioning (session state: %d)"),
+                mData->mSession.mState);
+    }
+    return rc;
+#endif /* else !defined (VBOX_WITH_GUEST_PROPS) */
 }
 

trunk/src/VBox/Main/SessionImpl.cpp

@@ -677 +677 @@
     else
         return mConsole->setGuestProperty (aKey, aValue);
+#else /* VBOX_WITH_GUEST_PROPS not defined */
+    return E_NOTIMPL;
+#endif /* VBOX_WITH_GUEST_PROPS not defined */
+}
+
+STDMETHODIMP Session::EnumerateGuestProperties (INPTR BSTR aPatterns,
+                                                ComSafeArrayOut(BSTR, aNames),
+                                                ComSafeArrayOut(BSTR, aValues),
+                                                ComSafeArrayOut(ULONG64, aTimestamps),
+                                                ComSafeArrayOut(BSTR, aFlags))
+{
+#ifdef VBOX_WITH_GUEST_PROPS
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
+
+    if (mState != SessionState_Open)
+        return setError (E_FAIL,
+            tr ("Machine session is not open (session state: %d)."),
+            mState);
+    AssertReturn (mType == SessionType_Direct, E_UNEXPECTED);
+    if (!VALID_PTR (aPatterns) && (aPatterns != NULL))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aNames))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aValues))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aTimestamps))
+        return E_POINTER;
+    if (ComSafeArrayOutIsNull (aFlags))
+        return E_POINTER;
+    return mConsole->enumerateGuestProperties(aPatterns,
+                                              ComSafeArrayOutArg(aNames),
+                                              ComSafeArrayOutArg(aValues),
+                                              ComSafeArrayOutArg(aTimestamps),
+                                              ComSafeArrayOutArg(aFlags));
 #else /* VBOX_WITH_GUEST_PROPS not defined */
     return E_NOTIMPL;

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -3522 +3522 @@
         Reads an entry from the machine's guest property store.
       </desc>
-      <param name="key" type="wstring" dir="in">
-        <desc>
-          The name of the key to read.
+      <param name="name" type="wstring" dir="in">
+        <desc>
+          The name of the property to read.
         </desc>
       </param>
       <param name="value" type="wstring" dir="out">
         <desc>
-          The value of the key.  If the key does not exist then this will be
+          The value of the property.  If the property does not exist then this
+          will be empty.
+        </desc>
+      </param>
+      <param name="timestamp" type="unsigned long long" dir="out">
+        <desc>
+          The time at which the property was last modified, as seen by the
+          server process.
+        </desc>
+      </param>
+      <param name="flags" type="wstring" dir="out">
+        <desc>
+          Additional property parameters, passed as a comma-separated list of
+          "name=value" type entries.
+        </desc>
+      </param>
+    </method>
+
+    <method name="getGuestPropertyValue">
+      <desc>
+        Reads a value from the machine's guest property store.
+      </desc>
+      <param name="property" type="wstring" dir="in">
+        <desc>
+          The name of the property to read.
+        </desc>
+      </param>
+      <param name="value" type="wstring" dir="return">
+        <desc>
+          The value of the property.  If the property does not exist then this
+          will be empty.
+        </desc>
+      </param>
+    </method>
+
+    <method name="getGuestPropertyTimestamp">
+      <desc>
+        Reads a property timestamp from the machine's guest property store.
+      </desc>
+      <param name="property" type="wstring" dir="in">
+        <desc>
+          The name of the property to read.
+        </desc>
+      </param>
+      <param name="value" type="unsigned long long" dir="return">
+        <desc>
+          The timestamp.  If the property does not exist then this will be
           empty.
-        </desc>
-      </param>
-      <param name="timestamp" type="unsigned long long" dir="out">
-        <desc>
-          The time at which the key was last modified, as seen by the server
-          process.
-        </desc>
-      </param>
-      <param name="flags" type="wstring" dir="out">
-        <desc>
-          Additional key parameters, passed as a comma-separated list of
-          "name=value" type entries.
-        </desc>
-      </param>
-    </method>
-
-    <method name="getGuestPropertyValue">
-      <desc>
-        Reads a value from the machine's guest property store.
-      </desc>
-      <param name="key" type="wstring" dir="in">
-        <desc>
-          The name of the key to read.
-        </desc>
-      </param>
-      <param name="value" type="wstring" dir="return">
-        <desc>
-          The value of the key.  If the key does not exist then this will be
-          empty.
-        </desc>
-      </param>
-    </method>
-
-    <method name="getGuestPropertyTimestamp">
-      <desc>
-        Reads a key timestamp from the machine's guest property store.
-      </desc>
-      <param name="key" type="wstring" dir="in">
-        <desc>
-          The name of the key to read.
-        </desc>
-      </param>
-      <param name="value" type="unsigned long long" dir="return">
-        <desc>
-          The timestamp.  If the key does not exist then this will be empty.
         </desc>
       </param>
@@ -3585 +3586 @@
         store.
       </desc>
-      <param name="key" type="wstring" dir="in">
-        <desc>
-          The name of the key to set, change or delete.
+      <param name="property" type="wstring" dir="in">
+        <desc>
+          The name of the property to set, change or delete.
         </desc>
       </param>
       <param name="value" type="wstring" dir="in">
         <desc>
-          The new value of the key to set, change or delete.  If the key does
-          not yet exist and value is non-empty, it will be created.  If value
-          is empty, the key will be deleted if it exists.
+          The new value of the property to set, change or delete.  If the
+          property does not yet exist and value is non-empty, it will be
+          created.  If the value is empty, the key will be deleted if it
+          exists.
         </desc>
       </param>
       <param name="flags" type="wstring" dir="in">
         <desc>
-          Additional key parameters, passed as a comma-separated list of
+          Additional property parameters, passed as a comma-separated list of
           "name=value" type entries.
         </desc>
@@ -3611 +3613 @@
         new property.
       </desc>
-      <param name="key" type="wstring" dir="in">
-        <desc>
-          The name of the key to set, change or delete.
+      <param name="property" type="wstring" dir="in">
+        <desc>
+          The name of the property to set, change or delete.
         </desc>
       </param>
       <param name="value" type="wstring" dir="in">
         <desc>
-          The new value of the key to set, change or delete.  If the key does
-          not yet exist and value is non-empty, it will be created.  If value
-          is empty, the key will be deleted if it exists.
+          The new value of the property to set, change or delete.  If the
+          property does not yet exist and value is non-empty, it will be
+          created.  If value is empty, the property will be deleted if it
+          exists.
         </desc>
       </param>
@@ -3633 +3636 @@
         <desc>
           The patterns to match the properties against as a comma-separated
-          string.  If this is empty, all properties currently set will be
-          returned.
-        </desc>
-      </param>
-      <param name="key" type="wstring" dir="out" safearray="yes">
-        <desc>
-          The key names of the properties returned.
+          string with no spaces.  If this is empty, all properties currently
+          set will be returned.
+        </desc>
+      </param>
+      <param name="name" type="wstring" dir="out" safearray="yes">
+        <desc>
+          The names of the properties returned.
         </desc>
       </param>
@@ -3645 +3648 @@
         <desc>
           The values of the properties returned.  The array entries match the
-          corresponding entries in the @a key array.
+          corresponding entries in the @a name array.
         </desc>
       </param>
@@ -3651 +3654 @@
         <desc>
           The timestamps of the properties returned.  The array entries match
-          the corresponding entries in the @a key array.
+          the corresponding entries in the @a name array.
         </desc>
       </param>
@@ -3657 +3660 @@
         <desc>
           The flags of the properties returned.  The array entries match the
-          corresponding entries in the @a key array.
+          corresponding entries in the @a name array.
         </desc>
       </param>
@@ -9777 +9780 @@
   <interface
      name="IInternalSessionControl" extends="$unknown"
-     uuid="ee0bec44-ffec-4994-8f15-c3dea54bbbb6"
+     uuid="0dc8dc04-2d4c-45e7-885c-a0afe7e4dfa7"
      internal="yes"
      wsmap="suppress"
@@ -9940 +9943 @@
       <param name="isSetter" type="boolean" dir="in"/>
       <param name="retValue" type="wstring" dir="return"/>
+    </method>
+
+    <method name="enumerateGuestProperties">
+      <desc>
+        Return a list of the guest properties matching a set of patterns along
+        with their values, timestamps and flags.
+      </desc>
+      <param name="patterns" type="wstring" dir="in">
+        <desc>
+          The patterns to match the properties against as a comma-separated
+          string.  If this is empty, all properties currently set will be
+          returned.
+        </desc>
+      </param>
+      <param name="key" type="wstring" dir="out" safearray="yes">
+        <desc>
+          The key names of the properties returned.
+        </desc>
+      </param>
+      <param name="value" type="wstring" dir="out" safearray="yes">
+        <desc>
+          The values of the properties returned.  The array entries match the
+          corresponding entries in the @a key array.
+        </desc>
+      </param>
+      <param name="timestamp" type="unsigned long long" dir="out" safearray="yes">
+        <desc>
+          The timestamps of the properties returned.  The array entries match
+          the corresponding entries in the @a key array.
+        </desc>
+      </param>
+      <param name="flags" type="wstring" dir="out" safearray="yes">
+        <desc>
+          The flags of the properties returned.  The array entries match the
+          corresponding entries in the @a key array.
+        </desc>
+      </param>
     </method>
 

trunk/src/VBox/Main/include/ConsoleImpl.h

@@ -184 +184 @@
     HRESULT getGuestProperty (INPTR BSTR aKey, BSTR *aValue);
     HRESULT setGuestProperty (INPTR BSTR aKey, INPTR BSTR aValue);
-
+    HRESULT enumerateGuestProperties (INPTR BSTR aPatterns, ComSafeArrayOut(BSTR, aNames), ComSafeArrayOut(BSTR, aValues), ComSafeArrayOut(ULONG64, aTimestamps), ComSafeArrayOut(BSTR, aFlags));
     VMMDev *getVMMDev() { return mVMMDev; }
     AudioSniffer *getAudioSniffer () { return mAudioSniffer; }

trunk/src/VBox/Main/include/SessionImpl.h

@@ -108 +108 @@
     STDMETHOD(AccessGuestProperty) (INPTR BSTR aKey, INPTR BSTR aValue,
                                     BOOL aIsSetter, BSTR *aRetValue);
+    STDMETHOD(EnumerateGuestProperties) (INPTR BSTR aPatterns,
+                                         ComSafeArrayOut(BSTR, aNames),
+                                         ComSafeArrayOut(BSTR, aValues),
+                                         ComSafeArrayOut(ULONG64, aTimestamps),
+                                         ComSafeArrayOut(BSTR, aFlags));
 
     // for VirtualBoxSupportErrorInfoImpl