Changeset 69067 in vbox for trunk/src/VBox/Devices/Samples

Timestamp:

Oct 13, 2017 8:41:13 AM (8 years ago)

Author:

vboxsync

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

118349

Message:

Devices/Samples: Separate the Playground device from the sample device, because the latter should be simple and clean, while the former is meant as a showcase for unusual things and therefore will have special needs.

Location:

trunk/src/VBox/Devices/Samples

Files:

• DevPlayground.cpp (modified) (9 diffs)
• Makefile.kmk (modified) (3 diffs)
• VBoxSampleDevice.cpp (modified) (1 diff)

trunk/src/VBox/Devices/Samples/DevPlayground.cpp

@@ -8 +8 @@
  *
  * To enable this device for a particular VM:
- * VBoxManage setextradata vmname VBoxInternal/PDM/Devices/playground/Path .../obj/VBoxSampleDevice/VBoxSampleDevice
+ * VBoxManage setextradata vmname VBoxInternal/PDM/Devices/playground/Path .../obj/VBoxPlaygroundDevice/VBoxPlaygroundDevice
  * VBoxManage setextradata vmname VBoxInternal/Devices/playground/0/Config/Whatever1 0
  */
 
 /*
- * Copyright (C) 2009-2016 Oracle Corporation
+ * Copyright (C) 2009-2017 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -33 +33 @@
 #include <VBox/err.h>
 #include <VBox/log.h>
+
+#include <VBox/com/assert.h>
+#include <VBox/com/defs.h>
+#include <VBox/com/string.h>
+#include <VBox/com/Guid.h>
+#include <VBox/com/VirtualBox.h>
 
 #include <iprt/assert.h>
@@ -67 +73 @@
 
 
+#define PLAYGROUND_SSM_VERSION 3
+
+
 /*********************************************************************************************************************************
 *   Device Functions                                                                                                             *
@@ -119 +128 @@
 
 /**
- * @interface_method_impl{PDMDEVREG,pfnDestruct}
- */
-static DECLCALLBACK(int) devPlaygroundDestruct(PPDMDEVINS pDevIns)
-{
-    /*
-     * Check the versions here as well since the destructor is *always* called.
-     */
-    PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
+ * @callback_method_impl{FNSSMDEVSAVEEXEC}
+ */
+static DECLCALLBACK(int) devPlaygroundSaveExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM)
+{
+    PVBOXPLAYGROUNDDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXPLAYGROUNDDEVICE);
+
+    /* dummy (real devices would need to save their state here) */
+    RT_NOREF(pThis);
+
+    /* Demo of some API stuff - very unusual, think twice if there's no better
+     * solution which doesn't need API interaction. */
+    HRESULT hrc = S_OK;
+    com::Bstr bstrSnapName;
+    com::Guid uuid(COM_IIDOF(ISnapshot));
+    ISnapshot *pSnap = (ISnapshot *)PDMDevHlpQueryGenericUserObject(pDevIns, uuid.raw());
+    if (pSnap)
+    {
+        hrc = pSnap->COMGETTER(Name)(bstrSnapName.asOutParam());
+        AssertComRCReturn(hrc, VERR_INVALID_STATE);
+    }
+    com::Utf8Str strSnapName(bstrSnapName);
+    SSMR3PutStrZ(pSSM, strSnapName.c_str());
+    LogRel(("Playground: saving state of snapshot '%s', hrc=%Rhrc\n", strSnapName.c_str(), hrc));
+
+    return VINF_SUCCESS;
+}
+
+/**
+ * @callback_method_impl{FNSSMDEVLOADEXEC}
+ */
+static DECLCALLBACK(int) devPlaygroundLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)
+{
+    PVBOXPLAYGROUNDDEVICE pThis = PDMINS_2_DATA(pDevIns, PVBOXPLAYGROUNDDEVICE);
+
+    if (uVersion > PLAYGROUND_SSM_VERSION)
+        return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
+    Assert(uPass == SSM_PASS_FINAL); NOREF(uPass);
+
+    /* dummy (real devices would need to load their state here) */
+    RT_NOREF(pThis);
+
+    /* Reading the stuff written to saved state, just a demo. */
+    char szSnapName[256];
+    int rc = SSMR3GetStrZ(pSSM, szSnapName, sizeof(szSnapName));
+    AssertRCReturn(rc, rc);
+    LogRel(("Playground: loading state of snapshot '%s'\n", szSnapName));
 
     return VINF_SUCCESS;
@@ -138 +185 @@
 {
     RT_NOREF(iInstance, pCfg);
+    int rc = VINF_SUCCESS;
 
     /*
@@ -171 +219 @@
             PCIDevSetHeaderType(&pFun->PciDev, 0x80); /* normal, multifunction device */
 
-        int rc = PDMDevHlpPCIRegisterEx(pDevIns, &pFun->PciDev, iPciFun, 0 /*fFlags*/, iPciDevNo, iPciFun,
+        rc = PDMDevHlpPCIRegisterEx(pDevIns, &pFun->PciDev, iPciFun, 0 /*fFlags*/, iPciDevNo, iPciFun,
                                         pThis->aPciFuns[iPciFun].szName);
         AssertLogRelRCReturn(rc, rc);
 
         /* First region. */
-        RTGCPHYS const cbFirst = iPciFun == 0 ? 8*_1G64 : iPciFun * _4K;
+        RTGCPHYS const cbFirst = iPciFun == 0 ? 8*_1M : iPciFun * _4K;
         rc = PDMDevHlpPCIIORegionRegisterEx(pDevIns, &pFun->PciDev, 0, cbFirst,
                                             (PCIADDRESSSPACE)(  PCI_ADDRESS_SPACE_MEM | PCI_ADDRESS_SPACE_BAR64
@@ -193 +241 @@
 
         /* Second region. */
-        RTGCPHYS const cbSecond = iPciFun == 0  ? 256*_1G64 : iPciFun * _32K;
+        RTGCPHYS const cbSecond = iPciFun == 0  ? 32*_1M : iPciFun * _32K;
         rc = PDMDevHlpPCIIORegionRegisterEx(pDevIns, &pFun->PciDev, 2, cbSecond,
                                             (PCIADDRESSSPACE)(  PCI_ADDRESS_SPACE_MEM | PCI_ADDRESS_SPACE_BAR64
@@ -213 +261 @@
     }
 
-    return VINF_SUCCESS;
-}
-
-RT_C_DECLS_BEGIN
-extern const PDMDEVREG g_DevicePlayground;
-RT_C_DECLS_END
+    /*
+     * Save state handling.
+     */
+    rc = PDMDevHlpSSMRegister(pDevIns, PLAYGROUND_SSM_VERSION, sizeof(*pThis), devPlaygroundSaveExec, devPlaygroundLoadExec);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    return VINF_SUCCESS;
+}
+
+
+/**
+ * @interface_method_impl{PDMDEVREG,pfnDestruct}
+ */
+static DECLCALLBACK(int) devPlaygroundDestruct(PPDMDEVINS pDevIns)
+{
+    /*
+     * Check the versions here as well since the destructor is *always* called.
+     */
+    PDMDEV_CHECK_VERSIONS_RETURN_QUIET(pDevIns);
+
+    return VINF_SUCCESS;
+}
+
 
 /**
  * The device registration structure.
  */
-const PDMDEVREG g_DevicePlayground =
+static const PDMDEVREG g_DevicePlayground =
 {
     /* u32Version */
@@ -274 +340 @@
     PDM_DEVREG_VERSION
 };
+
+
+/**
+ * Register devices provided by the plugin.
+ *
+ * @returns VBox status code.
+ * @param   pCallbacks      Pointer to the callback table.
+ * @param   u32Version      VBox version number.
+ */
+extern "C" DECLEXPORT(int) VBoxDevicesRegister(PPDMDEVREGCB pCallbacks, uint32_t u32Version)
+{
+    LogFlow(("VBoxPlaygroundDevice::VBoxDevicesRegister: u32Version=%#x pCallbacks->u32Version=%#x\n", u32Version, pCallbacks->u32Version));
+
+    AssertLogRelMsgReturn(u32Version >= VBOX_VERSION,
+                          ("VirtualBox version %#x, expected %#x or higher\n", u32Version, VBOX_VERSION),
+                          VERR_VERSION_MISMATCH);
+    AssertLogRelMsgReturn(pCallbacks->u32Version == PDM_DEVREG_CB_VERSION,
+                          ("callback version %#x, expected %#x\n", pCallbacks->u32Version, PDM_DEVREG_CB_VERSION),
+                          VERR_VERSION_MISMATCH);
+
+    return pCallbacks->pfnRegister(pCallbacks, &g_DevicePlayground);
+}
+

trunk/src/VBox/Devices/Samples/Makefile.kmk

@@ -5 +5 @@
 
 #
-# Copyright (C) 2009-2016 Oracle Corporation
+# Copyright (C) 2009-2017 Oracle Corporation
 #
 # This file is part of VirtualBox Open Source Edition (OSE), as
@@ -26 +26 @@
 VBoxSampleDevice_TEMPLATE = VBOXR3
 VBoxSampleDevice_SOURCES  = \
-        VBoxSampleDevice.cpp \
-        DevPlayground.cpp
+        VBoxSampleDevice.cpp
 VBoxSampleDevice_LIBS     = \
         $(LIB_RUNTIME) \
-        $(LIB_VMM) \
-        $(LIB_REM)
+        $(LIB_VMM)
 
 #
@@ -42 +40 @@
 VBoxSampleDriver_LIBS     = \
         $(LIB_RUNTIME) \
-        $(LIB_VMM) \
-        $(LIB_REM)
+        $(LIB_VMM)
+
+
+#
+# VBoxPlaygroundDevice - A device module demonstrating some unusual features.
+#
+DLLS += VBoxPlaygroundDevice
+VBoxPlaygroundDevice_TEMPLATE = VBOXR3
+VBoxPlaygroundDevice_SOURCES  = \
+        DevPlayground.cpp
+VBoxPlaygroundDevice_LIBS     = \
+        $(PATH_STAGE_LIB)/VBoxCOM$(VBOX_SUFF_LIB) \
+        $(LIB_RUNTIME) \
+        $(LIB_VMM)
+
+ifdef VBOX_WITH_XPCOM
+ ## @todo may be worth creating the VBOX_XPCOM SDK def, or just a SDK_VBOXXPCOM.
+ VBoxPlaygroundDevice_DEFS += VBOX_WITH_XPCOM
+ ifdef VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
+  VBoxPlaygroundDevice_DEFS += VBOX_WITH_XPCOM_NAMESPACE_CLEANUP
+ endif
+ VBoxPlaygroundDevice_INCS += \
+        $(VBOX_XPCOM_INCS)
+ VBoxPlaygroundDevice_INTERMEDIATES += \
+        $(VBOX_PATH_SDK)/bindings/xpcom/include/VirtualBox_XPCOM.h
+ VBoxPlaygroundDevice_LIBS += \
+        $(LIB_XPCOM)
+else  # COM
+ VBoxPlaygroundDevice_INCS += \
+        $(VBOX_PATH_SDK)/bindings/mscom/include
+ VBoxPlaygroundDevice_INTERMEDIATES += \
+        $(VBOX_PATH_SDK)/bindings/mscom/include/VirtualBox.h
+endif # COM
+
 
 include $(FILE_KBUILD_SUB_FOOTER)

trunk/src/VBox/Devices/Samples/VBoxSampleDevice.cpp

@@ -158 +158 @@
                           VERR_VERSION_MISMATCH);
 
-    /* Two devices in this module. */
-    extern const PDMDEVREG g_DevicePlayground;
-    int rc = pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
-    if (RT_SUCCESS(rc))
-        rc = pCallbacks->pfnRegister(pCallbacks, &g_DevicePlayground);
-    return rc;
+    return pCallbacks->pfnRegister(pCallbacks, &g_DeviceSample);
 }