Changeset 75495 in vbox

Timestamp:

Nov 15, 2018 8:53:00 PM (6 years ago)

Author:

vboxsync

Message:

HGCM,Main,SharedFolder,SharedClipboard,GuestProperties: Added HGCM service helpers for statistics and dbg info registration/deregistration. A PUVM is passed to HGCMService (where the helpers are implemented) when the service is loaded. Since this drags in both dbg.h and stam.h, LOG_GROUP defines now have to be at the top of the include list as everywhere else (i.e. hgcmsvc.h will define LOG_GROUP default by dragging in log.h). Added generic statistics of HGCM message processing and function level statistics to the shared folder service.

Location:

trunk

Files:

• include/VBox/HostServices/GuestPropertySvc.h (modified) (1 diff)
• include/VBox/hgcmsvc.h (modified) (2 diffs)
• src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp (modified) (2 diffs)
• src/VBox/Main/include/ConsoleImpl.h (modified) (1 diff)
• src/VBox/Main/include/HGCM.h (modified) (1 diff)
• src/VBox/Main/src-client/ConsoleImpl.cpp (modified) (1 diff)
• src/VBox/Main/src-client/ConsoleImpl2.cpp (modified) (4 diffs)
• src/VBox/Main/src-client/HGCM.cpp (modified) (22 diffs)
• src/VBox/Main/src-client/VMMDevInterface.cpp (modified) (2 diffs)
• src/VBox/VMM/VMMR3/VMMR3.def (modified) (1 diff)

trunk/include/VBox/HostServices/GuestPropertySvc.h

@@ -243 +243 @@
  * parameter for the flags. */
 #define GUEST_PROP_FN_HOST_SET_GLOBAL_FLAGS 7
-/** Return the pointer to a debug info function enumerating all guest
- * properties. */
-#define GUEST_PROP_FN_HOST_GET_DBGF_INFO    8
 /** @} */
 

trunk/include/VBox/hgcmsvc.h

@@ -28 +28 @@
 
 #include <iprt/assert.h>
+#include <iprt/stdarg.h>
 #include <iprt/string.h>
 #include <VBox/cdefs.h>
 #include <VBox/types.h>
 #include <VBox/err.h>
+#include <VBox/vmm/stam.h>
+#include <VBox/vmm/dbgf.h>
 #ifdef VBOX_TEST_HGCM_PARMS
 # include <iprt/test.h>
@@ -91 +94 @@
     DECLR3CALLBACKMEMBER(bool, pfnIsCallRestored, (VBOXHGCMCALLHANDLE callHandle));
 
+    /** Access to STAMR3RegisterV. */
+    DECLR3CALLBACKMEMBER(int, pfnStamRegisterV,(void *pvInstance, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
+                                                STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list va)
+                                                RT_IPRT_FORMAT_ATTR(7, 0));
+    /** Access to STAMR3DeregisterV. */
+    DECLR3CALLBACKMEMBER(int, pfnStamDeregisterV,(void *pvInstance, const char *pszPatFmt, va_list va) RT_IPRT_FORMAT_ATTR(2, 0));
+
+    /** Access to DBGFR3InfoRegisterExternal. */
+    DECLR3CALLBACKMEMBER(int, pfnInfoRegister,(void *pvInstance, const char *pszName, const char *pszDesc,
+                                               PFNDBGFHANDLEREXT pfnHandler, void *pvUser));
+    /** Access to DBGFR3InfoDeregisterExternal. */
+    DECLR3CALLBACKMEMBER(int, pfnInfoDeregister,(void *pvInstance, const char *pszName));
+
 } VBOXHGCMSVCHELPERS;
 
 typedef VBOXHGCMSVCHELPERS *PVBOXHGCMSVCHELPERS;
+
+#if defined(IN_RING3) || defined(IN_SLICKEDIT)
+
+/** Wrapper around STAMR3RegisterF. */
+DECLINLINE(int) RT_IPRT_FORMAT_ATTR(7, 8)
+HGCMSvcHlpStamRegister(PVBOXHGCMSVCHELPERS pHlp, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
+                       STAMUNIT enmUnit, const char *pszDesc, const char *pszName, ...)
+{
+    int rc;
+    va_list va;
+    va_start(va, pszName);
+    rc = pHlp->pfnStamRegisterV(pHlp->pvInstance, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
+    va_end(va);
+    return rc;
+}
+
+/** Wrapper around STAMR3RegisterV. */
+DECLINLINE(int) RT_IPRT_FORMAT_ATTR(7, 0)
+HGCMSvcHlpStamRegisterV(PVBOXHGCMSVCHELPERS pHlp, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
+                        STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list va)
+{
+    return pHlp->pfnStamRegisterV(pHlp->pvInstance, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
+}
+
+/** Wrapper around STAMR3DeregisterF. */
+DECLINLINE(int) RT_IPRT_FORMAT_ATTR(2, 3) HGCMSvcHlpStamDeregister(PVBOXHGCMSVCHELPERS pHlp, const char *pszPatFmt, ...)
+{
+    int rc;
+    va_list va;
+    va_start(va, pszPatFmt);
+    rc = pHlp->pfnStamDeregisterV(pHlp->pvInstance, pszPatFmt, va);
+    va_end(va);
+    return rc;
+}
+
+/** Wrapper around STAMR3DeregisterV. */
+DECLINLINE(int) RT_IPRT_FORMAT_ATTR(2, 0) HGCMSvcHlpStamDeregisterV(PVBOXHGCMSVCHELPERS pHlp, const char *pszPatFmt, va_list va)
+{
+    return pHlp->pfnStamDeregisterV(pHlp->pvInstance, pszPatFmt, va);
+}
+
+/** Wrapper around DBGFR3InfoRegisterExternal. */
+DECLINLINE(int) HGCMSvcHlpInfoRegister(PVBOXHGCMSVCHELPERS pHlp, const char *pszName, const char *pszDesc,
+                                       PFNDBGFHANDLEREXT pfnHandler, void *pvUser)
+{
+    return pHlp->pfnInfoRegister(pHlp->pvInstance, pszName, pszDesc, pfnHandler, pvUser);
+}
+
+/** Wrapper around DBGFR3InfoDeregisterExternal. */
+DECLINLINE(int) HGCMSvcHlpInfoDeregister(PVBOXHGCMSVCHELPERS pHlp, const char *pszName)
+{
+    return pHlp->pfnInfoDeregister(pHlp->pvInstance, pszName);
+}
+
+#endif /* IN_RING3 */
 
 

trunk/src/VBox/Additions/WINNT/VBoxTray/VBoxClipboard.cpp

@@ -20 +20 @@
 *   Header Files                                                                                                                 *
 *********************************************************************************************************************************/
+# define LOG_GROUP LOG_GROUP_SHARED_CLIPBOARD
 #include "VBoxTray.h"
 #include "VBoxHelpers.h"
@@ -29 +30 @@
 #include <strsafe.h>
 
-#ifdef DEBUG /** @todo r=bird: these are all default values. sigh. */
-# define LOG_ENABLED
-# define LOG_GROUP LOG_GROUP_SHARED_CLIPBOARD
-#endif
 #include <VBox/log.h>
 

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

@@ -735 +735 @@
                         bool fAttachDetach, bool fIgnoreConnectFailure);
     int i_configSerialPort(PCFGMNODE pInst, PortMode_T ePortMode, const char *pszPath, bool fServer);
-    static DECLCALLBACK(int) i_configGuestProperties(void *pvConsole, PUVM pUVM);
+    static DECLCALLBACK(int) i_configGuestProperties(void *pvConsole);
     static DECLCALLBACK(int) i_configGuestControl(void *pvConsole);
     static DECLCALLBACK(void) i_vmstateChangeCallback(PUVM pUVM, VMSTATE enmState, VMSTATE enmOldState, void *pvUser);

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

@@ -39 +39 @@
 int HGCMHostReset (void);
 
-int HGCMHostLoad (const char *pszServiceLibrary, const char *pszServiceName);
+int HGCMHostLoad (const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM);
 
 int HGCMHostRegisterServiceExtension (HGCMSVCEXTHANDLE *pHandle, const char *pszServiceName, PFNHGCMSVCEXT pfnExtension, void *pvExtension);

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

@@ -8218 +8218 @@
         alock.release();
 
-        DBGFR3InfoDeregisterExternal(pUVM, "guestprops"); /* will crash in unloaded code if we guru later */
         m_pVMMDev->hgcmShutdown();
 

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

@@ -3192 +3192 @@
          * Guest property service.
          */
-        rc = i_configGuestProperties(this, pUVM);
-#endif /* VBOX_WITH_GUEST_PROPS defined */
+        rc = i_configGuestProperties(this);
+#endif
 
 #ifdef VBOX_WITH_GUEST_CONTROL
@@ -3200 +3200 @@
          */
         rc = i_configGuestControl(this);
-#endif /* VBOX_WITH_GUEST_CONTROL defined */
+#endif
 
         /*
@@ -6091 +6091 @@
  * the machine XML and set a couple of initial properties.
  */
-/* static */ int Console::i_configGuestProperties(void *pvConsole, PUVM pUVM)
+/* static */ int Console::i_configGuestProperties(void *pvConsole)
 {
 #ifdef VBOX_WITH_GUEST_PROPS
@@ -6115 +6115 @@
          * change.
          */
-
-        {
-            VBOXHGCMSVCPARM Params[2];
-            int rc2 = pConsole->m_pVMMDev->hgcmHostCall("VBoxGuestPropSvc", GUEST_PROP_FN_HOST_GET_DBGF_INFO, 2, &Params[0]);
-            if (RT_SUCCESS(rc2))
-            {
-                PFNDBGFHANDLEREXT pfnHandler = (PFNDBGFHANDLEREXT)(uintptr_t)Params[0].u.pointer.addr;
-                void *pvService = Params[1].u.pointer.addr;
-                DBGFR3InfoRegisterExternal(pUVM, "guestprops", "Display the guest properties", pfnHandler, pvService);
-            }
-        }
 
         /* Sysprep execution by VBoxService. */

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

@@ -25 +25 @@
 #include <VBox/hgcmsvc.h>
 #include <VBox/vmm/ssm.h>
+#include <VBox/vmm/stam.h>
 #include <VBox/sup.h>
 
@@ -115 +116 @@
         HGCMSVCEXTHANDLE m_hExtension;
 
+        PUVM m_pUVM;
+
+        /** @name Statistics
+         * @{ */
+        STAMPROFILE m_StatHandleMsg;
+        /** @} */
+
         int loadServiceDLL(void);
         void unloadServiceDLL(void);
@@ -121 +129 @@
          * Main HGCM thread methods.
          */
-        int instanceCreate(const char *pszServiceLibrary, const char *pszServiceName);
+        int instanceCreate(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM);
         void instanceDestroy(void);
 
@@ -133 +141 @@
         static DECLCALLBACK(void) svcHlpDisconnectClient(void *pvInstance, uint32_t u32ClientId);
         static DECLCALLBACK(bool) svcHlpIsCallRestored(VBOXHGCMCALLHANDLE callHandle);
+        static DECLCALLBACK(int)  svcHlpStamRegisterV(void *pvInstance, void *pvSample, STAMTYPE enmType,
+                                                      STAMVISIBILITY enmVisibility, STAMUNIT enmUnit, const char *pszDesc,
+                                                      const char *pszName, va_list va);
+        static DECLCALLBACK(int)  svcHlpStamDeregisterV(void *pvInstance, const char *pszPatFmt, va_list va);
+        static DECLCALLBACK(int)  svcHlpInfoRegister(void *pvInstance, const char *pszName, const char *pszDesc,
+                                                     PFNDBGFHANDLEREXT pfnHandler, void *pvUser);
+        static DECLCALLBACK(int)  svcHlpInfoDeregister(void *pvInstance, const char *pszName);
 
     public:
@@ -139 +154 @@
          * Main HGCM thread methods.
          */
-        static int LoadService(const char *pszServiceLibrary, const char *pszServiceName);
+        static int LoadService(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM);
         void UnloadService(void);
 
@@ -243 +258 @@
     m_cHandleAcquires (0),
 #endif
-    m_hExtension (NULL)
+    m_hExtension (NULL),
+    m_pUVM       (NULL)
 {
     RT_ZERO(m_fntable);
@@ -380 +396 @@
 class HGCMMsgSvcLoad: public HGCMMsgCore
 {
+    public:
+        HGCMMsgSvcLoad() : HGCMMsgCore(), pUVM() {}
+
+        /** The user mode VM handle (for statistics and such). */
+        PUVM pUVM;
 };
 
@@ -525 +546 @@
         }
 
+        STAM_REL_PROFILE_START(&pSvc->m_StatHandleMsg, a);
+
         /* Cache required information to avoid unnecessary pMsgCore access. */
         uint32_t u32MsgId = pMsgCore->MsgId();
@@ -753 +776 @@
             hgcmMsgComplete (pMsgCore, rc);
         }
+        STAM_REL_PROFILE_STOP(&pSvc->m_StatHandleMsg, a);
     }
 }
@@ -807 +831 @@
 }
 
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnStamRegisterV}
+ */
+/* static */ DECLCALLBACK(int)
+HGCMService::svcHlpStamRegisterV(void *pvInstance, void *pvSample, STAMTYPE enmType, STAMVISIBILITY enmVisibility,
+                                 STAMUNIT enmUnit, const char *pszDesc, const char *pszName, va_list va)
+{
+     HGCMService *pService = static_cast <HGCMService *>(pvInstance);
+     AssertPtrReturn(pService, VERR_INVALID_PARAMETER);
+
+     return STAMR3RegisterVU(pService->m_pUVM, pvSample, enmType, enmVisibility, enmUnit, pszDesc, pszName, va);
+}
+
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnStamDeregisterV}
+ */
+/* static */ DECLCALLBACK(int) HGCMService::svcHlpStamDeregisterV(void *pvInstance, const char *pszPatFmt, va_list va)
+{
+     HGCMService *pService = static_cast <HGCMService *>(pvInstance);
+     AssertPtrReturn(pService, VERR_INVALID_PARAMETER);
+
+     return STAMR3DeregisterV(pService->m_pUVM, pszPatFmt, va);
+}
+
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnInfoRegister}
+ */
+/* static */ DECLCALLBACK(int) HGCMService::svcHlpInfoRegister(void *pvInstance, const char *pszName, const char *pszDesc,
+                                                               PFNDBGFHANDLEREXT pfnHandler, void *pvUser)
+{
+     HGCMService *pService = static_cast <HGCMService *>(pvInstance);
+     AssertPtrReturn(pService, VERR_INVALID_PARAMETER);
+
+     return DBGFR3InfoRegisterExternal(pService->m_pUVM, pszName, pszDesc, pfnHandler, pvUser);
+}
+
+/**
+ * @interface_method_impl{VBOXHGCMSVCHELPERS,pfnInfoDeregister}
+ */
+/* static */ DECLCALLBACK(int) HGCMService::svcHlpInfoDeregister(void *pvInstance, const char *pszName)
+{
+     HGCMService *pService = static_cast <HGCMService *>(pvInstance);
+     AssertPtrReturn(pService, VERR_INVALID_PARAMETER);
+
+     return DBGFR3InfoDeregisterExternal(pService->m_pUVM, pszName);
+}
+
+
 static DECLCALLBACK(void) hgcmMsgCompletionCallback(int32_t result, HGCMMsgCore *pMsgCore)
 {
@@ -824 +896 @@
  */
 
-int HGCMService::instanceCreate(const char *pszServiceLibrary, const char *pszServiceName)
+int HGCMService::instanceCreate(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM)
 {
     LogFlowFunc(("name %s, lib %s\n", pszServiceName, pszServiceLibrary));
-
     /* The maximum length of the thread name, allowed by the RT is 15. */
     char szThreadName[16];
@@ -856 +927 @@
         else
         {
+            /* Register statistics: */
+            m_pUVM = pUVM;
+            STAMR3RegisterFU(pUVM, &m_StatHandleMsg, STAMTYPE_PROFILE, STAMVISIBILITY_ALWAYS, STAMUNIT_OCCURENCES,
+                             "Message handling", "/HGCM/%s/Msg", pszServiceName);
+
             /* Initialize service helpers table. */
             m_svcHelpers.pfnCallComplete     = svcHlpCallComplete;
@@ -861 +937 @@
             m_svcHelpers.pfnDisconnectClient = svcHlpDisconnectClient;
             m_svcHelpers.pfnIsCallRestored   = svcHlpIsCallRestored;
+            m_svcHelpers.pfnStamRegisterV    = svcHlpStamRegisterV;
+            m_svcHelpers.pfnStamDeregisterV  = svcHlpStamDeregisterV;
+            m_svcHelpers.pfnInfoRegister     = svcHlpInfoRegister;
+            m_svcHelpers.pfnInfoDeregister   = svcHlpInfoDeregister;
 
             /* Execute the load request on the service thread. */
@@ -868 +948 @@
             if (RT_SUCCESS(rc))
             {
+                HGCMMsgSvcLoad *pMsg = (HGCMMsgSvcLoad *)hgcmObjReference(hMsg, HGCMOBJ_MSG);
+                AssertRelease(pMsg);
+                pMsg->pUVM = pUVM;
+                hgcmObjDereference(pMsg);
+
                 rc = hgcmMsgSend(hMsg);
             }
@@ -899 +984 @@
     }
 
+    if (m_pszSvcName)
+        STAMR3DeregisterF(m_pUVM, "/HGCM/%s/*", m_pszSvcName);
+    m_pUVM = NULL;
+
     RTStrFree(m_pszSvcLibrary);
     m_pszSvcLibrary = NULL;
@@ -960 +1049 @@
  * @param pszServiceLibrary  The library to be loaded.
  * @param pszServiceName     The name of the service.
+ * @param pUVM               The user mode VM handle (for statistics and such).
  * @return VBox rc.
  * @thread main HGCM
  */
-/* static */ int HGCMService::LoadService(const char *pszServiceLibrary, const char *pszServiceName)
-{
-    LogFlowFunc(("lib %s, name = %s\n", pszServiceLibrary, pszServiceName));
+/* static */ int HGCMService::LoadService(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM)
+{
+    LogFlowFunc(("lib %s, name = %s, pUVM = %p\n", pszServiceLibrary, pszServiceName, pUVM));
 
     /* Look at already loaded services to avoid double loading. */
@@ -981 +1071 @@
     {
         /* Create the new service. */
-        pSvc = new HGCMService();
+        pSvc = new (std::nothrow) HGCMService();
 
         if (!pSvc)
@@ -990 +1080 @@
         {
             /* Load the library and call the initialization entry point. */
-            rc = pSvc->instanceCreate(pszServiceLibrary, pszServiceName);
+            rc = pSvc->instanceCreate(pszServiceLibrary, pszServiceName, pUVM);
 
             if (RT_SUCCESS(rc))
@@ -1744 +1834 @@
         /* Name to be assigned to the service. */
         const char *pszServiceName;
+        /** The user mode VM handle (for statistics and such). */
+        PUVM pUVM;
 };
 
@@ -1916 +2008 @@
                 HGCMMsgMainLoad *pMsg = (HGCMMsgMainLoad *)pMsgCore;
 
-                LogFlowFunc(("HGCM_MSG_LOAD pszServiceName = %s, pMsg->pszServiceLibrary = %s\n",
-                             pMsg->pszServiceName, pMsg->pszServiceLibrary));
-
-                rc = HGCMService::LoadService(pMsg->pszServiceLibrary, pMsg->pszServiceName);
+                LogFlowFunc(("HGCM_MSG_LOAD pszServiceName = %s, pMsg->pszServiceLibrary = %s, pMsg->pUVM = %p\n",
+                             pMsg->pszServiceName, pMsg->pszServiceLibrary, pMsg->pUVM));
+
+                rc = HGCMService::LoadService(pMsg->pszServiceLibrary, pMsg->pszServiceName, pMsg->pUVM);
             } break;
 
@@ -2109 +2201 @@
  * @param pszServiceLibrary  The library to be loaded.
  * @param pszServiceName     The name to be assigned to the service.
+ * @param pUVM               The user mode VM handle (for statistics and such).
  * @return VBox rc.
  */
 int HGCMHostLoad(const char *pszServiceLibrary,
-                 const char *pszServiceName)
+                 const char *pszServiceName,
+                 PUVM pUVM)
 {
     LogFlowFunc(("lib = %s, name = %s\n", pszServiceLibrary, pszServiceName));
@@ -2134 +2228 @@
         pMsg->pszServiceLibrary = pszServiceLibrary;
         pMsg->pszServiceName    = pszServiceName;
+        pMsg->pUVM              = pUVM;
 
         hgcmObjDereference(pMsg);

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

@@ -98 +98 @@
     {
         ASMAtomicWriteBool(&m_fHGCMActive, false);
-        if (mParent)
-        {
-            Console::SafeVMPtrQuiet ptrVM(mParent);
-            if (ptrVM.rawUVM())
-                DBGFR3InfoDeregisterExternal(ptrVM.rawUVM(), "guestprops"); /* will crash in unloaded code if we guru later */
-        }
         HGCMHostShutdown();
     }
@@ -701 +695 @@
         return VERR_INVALID_STATE;
 
-    return HGCMHostLoad(pszServiceLibrary, pszServiceName);
+    Console::SafeVMPtrQuiet ptrVM(mParent);
+    return HGCMHostLoad(pszServiceLibrary, pszServiceName, ptrVM.rawUVM());
 }
 

trunk/src/VBox/VMM/VMMR3/VMMR3.def

@@ -361 +361 @@
     STAMR3SnapshotFree
     STAMR3GetUnit
+    STAMR3RegisterFU
+    STAMR3RegisterVU
+    STAMR3DeregisterF
+    STAMR3DeregisterV
 
     TMR3TimerSetCritSect