Changeset 52789 in vbox for trunk/src/VBox/Devices

Timestamp:

Sep 18, 2014 4:08:18 PM (10 years ago)

Author:

vboxsync

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

96175

Message:

VMMDev/Main, Additions: Guest heartbeat implementation. VMMDev reports to host log if missed heartbeat from the guest.

Location:

trunk/src/VBox/Devices

Files:

• VMMDev/VMMDev.cpp (modified) (6 diffs)
• VMMDev/VMMDevState.h (modified) (1 diff)
• testcase/tstDeviceStructSizeRC.cpp (modified) (2 diffs)

trunk/src/VBox/Devices/VMMDev/VMMDev.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2013 Oracle Corporation
+ * Copyright (C) 2006-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -90 +90 @@
  *  This doesn't have the config part. */
 #define VMMDEV_SAVED_STATE_VERSION_VBOX_30                      11
+/** Default interval in nanoseconds between guest heartbeats.
+ *  Used when no HeartbeatInterval is set in CFGM and for setting
+ *  HB check timer if the guest's heartbeat frequency is less than 1Hz. */
+#define HEARTBEAT_DEFAULT_INTERVAL            UINT64_C(2000000000)
 
 
@@ -350 +354 @@
 
     return VINF_SUCCESS;
+}
+
+
+/**
+ * Resets heartbeat timer.
+ *
+ * @param   pThis           The VMMDev state.
+ * @returns VBox status code.
+ */
+static int vmmDevHeartbeatTimerReset(PVMMDEV pThis)
+{
+    if (pThis->fHBCheckEnabled)
+        return TMTimerSetNano(pThis->pHBCheckTimer, pThis->u64HeartbeatTimeout);
+
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * Handles VMMDevReq_GuestHeartbeat.
+ *
+ * @returns VBox status code that the guest should see.
+ * @param   pThis    The VMMDev instance data.
+ */
+static int vmmDevReqHandler_GuestHeartbeat(PVMMDEV pThis)
+{
+    int rc = VINF_SUCCESS;
+
+    if (pThis->fHBCheckEnabled)
+    {
+        ASMAtomicWriteU64(&pThis->uLastHBTime, TMTimerGetNano(pThis->pHBCheckTimer));
+        if (pThis->fHasMissedHB)
+        {
+            LogRel(("vmmDevReqHandler_GuestHeartBeat: guest is alive\n"));
+            ASMAtomicWriteBool(&pThis->fHasMissedHB, false);
+        }
+        rc = vmmDevHeartbeatTimerReset(pThis);
+    }
+    return rc;
+}
+
+
+/**
+ * Guest heartbeat check timer. Fires if there are no heartbeats for certain time.
+ * Timer is set in vmmDevHeartbeatTimerReset.
+ */
+static DECLCALLBACK(void) vmmDevHeartBeatCheckTimer(PPDMDEVINS pDevIns, PTMTIMER pTimer, void *pvUser)
+{
+    PVMMDEV pThis = (PVMMDEV) pvUser;
+    if (pThis->fHBCheckEnabled)
+    {
+        uint64_t interval = TMTimerGetNano(pTimer) - pThis->uLastHBTime;
+        if (!pThis->fHasMissedHB && interval >= pThis->u64HeartbeatInterval)
+        {
+            LogRel(("vmmDevHeartBeatCheckTimer: guest seems to be not responding, last heartbeat received %RU64 sec ago\n", interval / 1000000000));
+            ASMAtomicWriteBool(&pThis->fHasMissedHB, true);
+        }
+    }
+}
+
+
+/**
+ * Handles VMMDevReq_HeartbeatConfigure.
+ *
+ * @returns VBox status code that the guest should see.
+ * @param   pThis     The VMMDev instance data.
+ * @param   pReqHdr   The header of the request to handle.
+ */
+static int vmmDevReqHandler_HeartbeatConfigure(PVMMDEV pThis, VMMDevRequestHeader *pReqHdr)
+{
+    AssertMsgReturn(pReqHdr->size == sizeof(VMMDevReqHeartbeat), ("%u\n", pReqHdr->size), VERR_INVALID_PARAMETER);
+    VMMDevReqHeartbeat *pReq = (VMMDevReqHeartbeat *)pReqHdr;
+    int rc;
+
+    pReq->cNsInterval = pThis->u64HeartbeatInterval;
+
+    if (pReq->fEnabled != pThis->fHBCheckEnabled)
+    {
+        ASMAtomicWriteBool(&pThis->fHBCheckEnabled, pReq->fEnabled);
+        if (pReq->fEnabled)
+        {
+            /* set first timer explicitly */
+            rc = vmmDevHeartbeatTimerReset(pThis);
+            if (RT_SUCCESS(rc))
+            {
+                LogRel(("Heartbeat checking timer has been set to trigger every %RU64 sec\n", pThis->u64HeartbeatInterval / 500000000));
+            }
+            else
+                LogRel(("Cannot create heartbeat check timer, rc=%Rrc\n", rc));
+        }
+        else
+        {
+            rc = TMTimerStop(pThis->pHBCheckTimer);
+            LogRel(("Heartbeat checking timer has been stopped, rc=%Rrc\n", rc));
+        }
+    }
+    else
+    {
+        LogRel(("vmmDevReqHandler_HeartbeatConfigure: enabled=%d\n", pThis->fHBCheckEnabled));
+        rc = VINF_SUCCESS;
+    }
+
+    return rc;
 }
 
@@ -2517 +2624 @@
         }
 
+        case VMMDevReq_GuestHeartbeat:
+            pReqHdr->rc = vmmDevReqHandler_GuestHeartbeat(pThis);
+            break;
+
+        case VMMDevReq_HeartbeatConfigure:
+            pReqHdr->rc = vmmDevReqHandler_HeartbeatConfigure(pThis, pReqHdr);
+            break;
+
         default:
         {
@@ -3823 +3938 @@
                                 N_("Configuration error: Failed querying \"GuestCoreDumpCount\" as a 32-bit unsigned integer"));
 
+    rc = CFGMR3QueryU64Def(pCfg, "HeartbeatInterval", &pThis->u64HeartbeatInterval, HEARTBEAT_DEFAULT_INTERVAL);
+    if (RT_FAILURE(rc))
+        return PDMDEV_SET_ERROR(pDevIns, rc,
+                                N_("Configuration error: Failed querying \"HeartbeatInterval\" as a 64-bit unsigned integer"));
+
+    rc = CFGMR3QueryU64Def(pCfg, "HeartbeatTimeout", &pThis->u64HeartbeatTimeout, pThis->u64HeartbeatInterval * 2);
+    if (RT_FAILURE(rc))
+        return PDMDEV_SET_ERROR(pDevIns, rc,
+                                N_("Configuration error: Failed querying \"HeartbeatTimeout\" as a 64-bit unsigned integer"));
+
 #ifndef VBOX_WITHOUT_TESTING_FEATURES
     rc = CFGMR3QueryBoolDef(pCfg, "TestingEnabled", &pThis->fTestingEnabled, false);
@@ -3967 +4092 @@
                                 NULL, vmmdevSaveExec, NULL,
                                 NULL, vmmdevLoadExec, vmmdevLoadStateDone);
+    AssertRCReturn(rc, rc);
+
+    /*
+     * Create heartbeat checking timer.
+     */
+    rc = PDMDevHlpTMTimerCreate(pDevIns, TMCLOCK_VIRTUAL, vmmDevHeartBeatCheckTimer, pThis,
+                        TMTIMER_FLAGS_NO_CRIT_SECT, "HB Check Timer", &pThis->pHBCheckTimer);
     AssertRCReturn(rc, rc);
 

trunk/src/VBox/Devices/VMMDev/VMMDevState.h

@@ -359 +359 @@
     RTTEST                  hTestingTest;
 #endif /* !VBOX_WITHOUT_TESTING_FEATURES */
+
+    /** Timestamp of the last heartbeat from guest in nanosec. */
+    uint64_t volatile   uLastHBTime;
+    /** Indicates whether we missed HB from guest on last check. */
+    bool volatile       fHasMissedHB;
+    /** Indicates whether heartbeat check is active. */
+    bool volatile       fHBCheckEnabled;
+    /** Alignment padding. */
+    bool                afAlignment8[6];
+    /** Guest heartbeat interval in nanoseconds. */
+    uint64_t            u64HeartbeatInterval;
+    /** Guest heartbeat timeout in nanoseconds. */
+    uint64_t            u64HeartbeatTimeout;
+    /** Timer for checking guest heart beat. */
+    PTMTIMERR3          pHBCheckTimer;
 } VMMDevState;
 typedef VMMDevState VMMDEV;

trunk/src/VBox/Devices/testcase/tstDeviceStructSizeRC.cpp

@@ -8 +8 @@
 
 /*
- * Copyright (C) 2006-2012 Oracle Corporation
+ * Copyright (C) 2006-2014 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -1659 +1659 @@
     GEN_CHECK_OFF(VMMDEV, TestingData.Value.u32Unit);
     GEN_CHECK_OFF(VMMDEV, TestingData.Value.szName);
+    GEN_CHECK_OFF(VMMDEV, uLastHBTime);
+    GEN_CHECK_OFF(VMMDEV, fHasMissedHB);
+    GEN_CHECK_OFF(VMMDEV, fHBCheckEnabled);
+    GEN_CHECK_OFF(VMMDEV, u64HeartbeatInterval);
+    GEN_CHECK_OFF(VMMDEV, u64HeartbeatTimeout);
+    GEN_CHECK_OFF(VMMDEV, pHBCheckTimer);
 
 #ifdef VBOX_WITH_BUSLOGIC