Changeset 68986 in vbox

Timestamp:

Oct 4, 2017 2:37:38 PM (8 years ago)

Author:

vboxsync

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

118254

Message:

VMM: Add new QueryGenericObject entry to VMM2USER callback table, for querying API objects by UUID.
PDM: Add new QueryGenericUserObject entry to trusted DevHlp callback table, for querying API objects by UUID from PDM devices.
Main/Session+Console+Machine+Snapshot: Implement this callback and provide the console and snapshot objects this way.

Location:

trunk

Files:

• include/VBox/vmm/pdmdev.h (modified) (3 diffs)
• include/VBox/vmm/vmm.h (modified) (2 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (1 diff)
• src/VBox/Main/include/ConsoleImpl.h (modified) (3 diffs)
• src/VBox/Main/include/SessionImpl.h (modified) (2 diffs)
• src/VBox/Main/src-client/ConsoleImpl.cpp (modified) (6 diffs)
• src/VBox/Main/src-client/SessionImpl.cpp (modified) (3 diffs)
• src/VBox/Main/src-server/MachineImpl.cpp (modified) (1 diff)
• src/VBox/Main/src-server/SnapshotImpl.cpp (modified) (1 diff)
• src/VBox/VMM/VMMR3/PDMDevHlp.cpp (modified) (4 diffs)

trunk/include/VBox/vmm/pdmdev.h

@@ -1878 +1878 @@
 
 /** Current PDMDEVHLPR3 version number. */
-#define PDM_DEVHLPR3_VERSION                    PDM_VERSION_MAKE_PP(0xffe7, 21, 0)
+#define PDM_DEVHLPR3_VERSION                    PDM_VERSION_MAKE_PP(0xffe7, 22, 0)
 
 /**
@@ -3481 +3481 @@
     DECLR3CALLBACKMEMBER(PSUPDRVSESSION, pfnGetSupDrvSession,(PPDMDEVINS pDevIns));
 
+    /**
+     * Queries a generic object from the VMM user.
+     *
+     * @returns Pointer to the object if found, NULL if not.
+     * @param   pDevIns             The device instance.
+     * @param   pUuid               The UUID of what's being queried.  The UUIDs and
+     *                              the usage conventions are defined by the user.
+     *
+     * @note    It is strictly forbidden to call this internally in VBox!  This
+     *          interface is exclusively for hacks in externally developed devices.
+     */
+    DECLR3CALLBACKMEMBER(void *, pfnQueryGenericUserObject,(PPDMDEVINS pDevIns, PCRTUUID pUuid));
+
     /** @} */
 
@@ -5359 +5372 @@
 }
 
+/**
+ * @copydoc PDMDEVHLPR3::pfnQueryGenericUserObject
+ */
+DECLINLINE(void *) PDMDevHlpQueryGenericUserObject(PPDMDEVINS pDevIns, PCRTUUID pUuid)
+{
+    return pDevIns->pHlpR3->pfnQueryGenericUserObject(pDevIns, pUuid);
+}
+
 #endif /* IN_RING3 */
 #ifdef IN_RING0

trunk/include/VBox/vmm/vmm.h

@@ -237 +237 @@
     DECLR3CALLBACKMEMBER(void, pfnNotifyResetTurnedIntoPowerOff,(PCVMM2USERMETHODS pThis, PUVM pUVM));
 
+    /**
+     * Generic object query by UUID.
+     *
+     * @returns pointer to queried the object on success, NULL if not found.
+     *
+     * @param   pThis       Pointer to the callback method table.
+     * @param   pUVM        The user mode VM handle.
+     * @param   pUuid       The UUID of what's being queried.  The UUIDs and the
+     *                      usage conventions are defined by the user.
+     *
+     * @remarks This is optional and shall be set to NULL if not wanted.
+     */
+    DECLR3CALLBACKMEMBER(void *, pfnQueryGenericObject,(PCVMM2USERMETHODS pThis, PUVM pUVM, PCRTUUID pUuid));
+
     /** Magic value (VMM2USERMETHODS_MAGIC) marking the end of the structure. */
     uint32_t    u32EndMagic;
@@ -244 +258 @@
 #define VMM2USERMETHODS_MAGIC         UINT32_C(0x18830703)
 /** The VMM2USERMETHODS structure version. */
-#define VMM2USERMETHODS_VERSION       UINT32_C(0x00020001)
+#define VMM2USERMETHODS_VERSION       UINT32_C(0x00030000)
 
 

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

@@ -20350 +20350 @@
         <desc>Progress object to track the operation completion.</desc>
       </param>
+      <param name="snapshot" type="ISnapshot" dir="in">
+        <desc>Snapshot object for which this save state operation is executed.</desc>
+      </param>
       <param name="stateFilePath" type="wstring" dir="in">
         <desc>File path the VM process must save the execution state to.</desc>

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

@@ -229 +229 @@
     HRESULT i_pause(Reason_T aReason);
     HRESULT i_resume(Reason_T aReason, AutoWriteLock &alock);
-    HRESULT i_saveState(Reason_T aReason, const ComPtr<IProgress> &aProgress, const Utf8Str &aStateFilePath, bool fPauseVM, bool &fLeftPaused);
+    HRESULT i_saveState(Reason_T aReason, const ComPtr<IProgress> &aProgress,
+                        const ComPtr<ISnapshot> &aSnapshot,
+                        const Utf8Str &aStateFilePath, bool fPauseVM, bool &fLeftPaused);
     HRESULT i_cancelSaveState();
 
@@ -777 +779 @@
     static DECLCALLBACK(void)   i_vmm2User_NotifyPdmtTerm(PCVMM2USERMETHODS pThis, PUVM pUVM);
     static DECLCALLBACK(void)   i_vmm2User_NotifyResetTurnedIntoPowerOff(PCVMM2USERMETHODS pThis, PUVM pUVM);
+    static DECLCALLBACK(void *) i_vmm2User_QueryGenericObject(PCVMM2USERMETHODS pThis, PUVM pUVM, PCRTUUID pUuid);
 
     static DECLCALLBACK(void *) i_drvStatus_QueryInterface(PPDMIBASE pInterface, const char *pszIID);
@@ -909 +912 @@
     {
         Console *pConsole;
+        /** The in-progress snapshot. */
+        ISnapshot *pISnapshot;
     } *mpVmm2UserMethods;
 

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2016 Oracle Corporation
+ * Copyright (C) 2006-2017 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -137 +137 @@
     HRESULT saveStateWithReason(Reason_T aReason,
                                 const ComPtr<IProgress> &aProgress,
+                                const ComPtr<ISnapshot> &aSnapshot,
                                 const Utf8Str &aStateFilePath,
                                 BOOL aPauseVM,

trunk/src/VBox/Main/src-client/ConsoleImpl.cpp

@@ -446 +446 @@
     pVmm2UserMethods->pfnNotifyPdmtTerm = Console::i_vmm2User_NotifyPdmtTerm;
     pVmm2UserMethods->pfnNotifyResetTurnedIntoPowerOff = Console::i_vmm2User_NotifyResetTurnedIntoPowerOff;
+    pVmm2UserMethods->pfnQueryGenericObject = Console::i_vmm2User_QueryGenericObject;
     pVmm2UserMethods->u32EndMagic       = VMM2USERMETHODS_MAGIC;
     pVmm2UserMethods->pConsole          = this;
@@ -6576 +6577 @@
  * @note Locks this object for writing.
  */
-HRESULT Console::i_saveState(Reason_T aReason, const ComPtr<IProgress> &aProgress, const Utf8Str &aStateFilePath, bool aPauseVM, bool &aLeftPaused)
+HRESULT Console::i_saveState(Reason_T aReason, const ComPtr<IProgress> &aProgress,
+                             const ComPtr<ISnapshot> &aSnapshot,
+                             const Utf8Str &aStateFilePath, bool aPauseVM, bool &aLeftPaused)
 {
     LogFlowThisFuncEnter();
@@ -6583 +6586 @@
     AssertReturn(!aProgress.isNull(), E_INVALIDARG);
     AssertReturn(!aStateFilePath.isEmpty(), E_INVALIDARG);
+    Assert(aSnapshot.isNull() || aReason == Reason_Snapshot);
 
     AutoCaller autoCaller(this);
@@ -6650 +6654 @@
     LogFlowFunc(("Saving the state to '%s'...\n", aStateFilePath.c_str()));
 
+    mpVmm2UserMethods->pISnapshot = aSnapshot;
     mptrCancelableProgress = aProgress;
     alock.release();
@@ -6659 +6664 @@
                        &aLeftPaused);
     alock.acquire();
+    mpVmm2UserMethods->pISnapshot = NULL;
     mptrCancelableProgress.setNull();
     if (RT_FAILURE(vrc))
@@ -10335 +10341 @@
 }
 
-
+/**
+ * @interface_method_impl{VMM2USERMETHODS,pfnQueryGenericObject}
+ */
+/*static*/ DECLCALLBACK(void *)
+Console::i_vmm2User_QueryGenericObject(PCVMM2USERMETHODS pThis, PUVM pUVM, PCRTUUID pUuid)
+{
+    Console *pConsole = ((MYVMM2USERMETHODS *)pThis)->pConsole;
+    NOREF(pUVM);
+
+    /* To simplify comparison we copy the UUID into a com::Guid object. */
+    com::Guid const UuidCopy(*pUuid);
+
+    if (UuidCopy == COM_IIDOF(IConsole))
+    {
+        IConsole *pIConsole = static_cast<IConsole *>(pConsole);
+        return pIConsole;
+    }
+
+    if (UuidCopy == COM_IIDOF(IMachine))
+    {
+        IMachine *pIMachine = pConsole->mMachine;
+        return pIMachine;
+    }
+
+    if (UuidCopy == COM_IIDOF(ISnapshot))
+        return ((MYVMM2USERMETHODS *)pThis)->pISnapshot;
+
+    return NULL;
+}
 
 

trunk/src/VBox/Main/src-client/SessionImpl.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2016 Oracle Corporation
+ * Copyright (C) 2006-2017 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1067 +1067 @@
 }
 
-HRESULT Session::saveStateWithReason(Reason_T aReason, const ComPtr<IProgress> &aProgress, const Utf8Str &aStateFilePath,
+HRESULT Session::saveStateWithReason(Reason_T aReason,
+                                     const ComPtr<IProgress> &aProgress,
+                                     const ComPtr<ISnapshot> &aSnapshot,
+                                     const Utf8Str &aStateFilePath,
                                      BOOL aPauseVM, BOOL *aLeftPaused)
 {
@@ -1077 +1080 @@
 
     bool fLeftPaused = false;
-    HRESULT rc = mConsole->i_saveState(aReason, aProgress, aStateFilePath, !!aPauseVM, fLeftPaused);
+    HRESULT rc = mConsole->i_saveState(aReason, aProgress, aSnapshot, aStateFilePath, !!aPauseVM, fLeftPaused);
     if (aLeftPaused)
         *aLeftPaused = fLeftPaused;
     return rc;
 #else
-    RT_NOREF(aReason, aProgress, aStateFilePath, aPauseVM, aLeftPaused);
+    RT_NOREF(aReason, aProgress, aSnapshot, aStateFilePath, aPauseVM, aLeftPaused);
     AssertFailed();
     return E_NOTIMPL;

trunk/src/VBox/Main/src-server/MachineImpl.cpp

@@ -12984 +12984 @@
         alock.release();
         BOOL fSuspendedBySave;
-        rc = directControl->SaveStateWithReason(task.m_enmReason, task.m_pProgress, Bstr(task.m_strStateFilePath).raw(), task.m_machineStateBackup != MachineState_Paused, &fSuspendedBySave);
+        rc = directControl->SaveStateWithReason(task.m_enmReason, task.m_pProgress, NULL, Bstr(task.m_strStateFilePath).raw(), task.m_machineStateBackup != MachineState_Paused, &fSuspendedBySave);
         Assert(!fSuspendedBySave);
         alock.acquire();

trunk/src/VBox/Main/src-server/SnapshotImpl.cpp

@@ -1735 +1735 @@
                 rc = task.m_pDirectControl->SaveStateWithReason(Reason_Snapshot,
                                                                 task.m_pProgress,
+                                                                task.m_pSnapshot,
                                                                 Bstr(task.m_strStateFilePath).raw(),
                                                                 task.m_fPause,

trunk/src/VBox/VMM/VMMR3/PDMDevHlp.cpp

@@ -815 +815 @@
     LogFlow(("pdmR3DevHlp_GetSupDrvSession: caller='%s'/%d: returns %#p\n", pDevIns->pReg->szName, pDevIns->iInstance, pSession));
     return pSession;
+}
+
+
+/** @interface_method_impl{PDMDEVHLPR3,pfnQueryGenericUserObject} */
+static DECLCALLBACK(void *) pdmR3DevHlp_QueryGenericUserObject(PPDMDEVINS pDevIns, PCRTUUID pUuid)
+{
+    PDMDEV_ASSERT_DEVINS(pDevIns);
+    LogFlow(("pdmR3DevHlp_QueryGenericUserObject: caller='%s'/%d: pUuid=%p:%RTuuid\n",
+             pDevIns->pReg->szName, pDevIns->iInstance, pUuid, pUuid));
+
+#if defined(DEBUG_bird) || defined(DEBUG_ramshankar) || defined(DEBUG_sunlover) || defined(DEBUG_michael) || defined(DEBUG_andy)
+    AssertMsgFailed(("'%s' wants %RTuuid - external only interface!\n", pDevIns->pReg->szName, pUuid))
+#endif
+
+    void *pvRet;
+    PUVM  pUVM = pDevIns->Internal.s.pVMR3->pUVM;
+    if (pUVM->pVmm2UserMethods->pfnQueryGenericObject)
+        pvRet = pUVM->pVmm2UserMethods->pfnQueryGenericObject(pUVM->pVmm2UserMethods, pUVM, pUuid);
+    else
+        pvRet = NULL;
+
+    LogRel(("pdmR3DevHlp_QueryGenericUserObject: caller='%s'/%d: returns %#p for %RTuuid\n",
+            pDevIns->pReg->szName, pDevIns->iInstance, pvRet, pUuid));
+    return pvRet;
 }
 
@@ -3728 +3752 @@
     pdmR3DevHlp_TMTimeVirtGetNano,
     pdmR3DevHlp_GetSupDrvSession,
+    pdmR3DevHlp_QueryGenericUserObject,
     PDM_DEVHLPR3_VERSION /* the end */
 };
@@ -3861 +3886 @@
     AssertReleaseMsgFailed(("Untrusted device called trusted helper! '%s'/%d\n", pDevIns->pReg->szName, pDevIns->iInstance));
     return (PSUPDRVSESSION)0;
+}
+
+
+/** @interface_method_impl{PDMDEVHLPR3,pfnQueryGenericUserObject} */
+static DECLCALLBACK(void *) pdmR3DevHlp_Untrusted_QueryGenericUserObject(PPDMDEVINS pDevIns, PCRTUUID pUuid)
+{
+    PDMDEV_ASSERT_DEVINS(pDevIns);
+    AssertReleaseMsgFailed(("Untrusted device called trusted helper! '%s'/%d %RTuuid\n",
+                            pDevIns->pReg->szName, pDevIns->iInstance, pUuid));
+    return NULL;
 }
 
@@ -3987 +4022 @@
     pdmR3DevHlp_TMTimeVirtGetNano,
     pdmR3DevHlp_Untrusted_GetSupDrvSession,
+    pdmR3DevHlp_Untrusted_QueryGenericUserObject,
     PDM_DEVHLPR3_VERSION /* the end */
 };