Changeset 83062 in vbox for trunk

Timestamp:

Feb 12, 2020 5:45:51 PM (5 years ago)

Author:

vboxsync

Message:

Devices/testcase/tstDevice: Implement JSON based configuration loader for the device testbench

Location:

trunk/src/VBox/Devices

Files:

• Makefile.kmk (modified) (1 diff)
• testcase/tstDevice.cpp (modified) (8 diffs)
• testcase/tstDeviceCfg.cpp (added)
• testcase/tstDeviceCfg.h (added)
• testcase/tstDeviceInternal.h (modified) (2 diffs)
• testcase/tstDevicePdmDevHlp.cpp (modified) (8 diffs)
• testcase/tstDevicePlugin.h (modified) (1 diff)

trunk/src/VBox/Devices/Makefile.kmk

@@ -1351 +1351 @@
   tstDevice_SOURCES     = \
         testcase/tstDevice.cpp \
+        testcase/tstDeviceCfg.cpp \
         testcase/tstDevicePdmDevHlp.cpp
  endif

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

@@ -39 +39 @@
 
 #include "tstDeviceInternal.h"
+#include "tstDeviceCfg.h"
 
 
@@ -805 +806 @@
 
 
-static TSTDEVCFGITEM s_aTestcaseCfg[] =
-{
-    {"CtrlMemBufSize", TSTDEVCFGITEMTYPE_INTEGER, "0"  },
-    {NULL,             TSTDEVCFGITEMTYPE_INVALID, NULL }
-};
-
-static TSTDEVTESTCASEREG s_TestcaseDef =
-{
-    "test",
-    "Testcase during implementation",
-    "serial",
-    0,
-    &s_aTestcaseCfg[0],
-    NULL,
-};
-
 /**
  * Create a new PDM device with default config.
@@ -826 +811 @@
  * @returns VBox status code.
  * @param   pszName                 Name of the device to create.
- */
-static int tstDevPdmDevCreate(const char *pszName)
+ * @param   fR0Enabled              Flag whether R0 support should be enabled for this device.
+ * @param   fRCEnabled              Flag whether RC support should be enabled for this device.
+ * @param   pDut                    The device under test structure the created PDM device instance is exercised under.
+ */
+static int tstDevPdmDevCreate(const char *pszName, bool fR0Enabled, bool fRCEnabled, PTSTDEVDUTINT pDut)
 {
     int rc = VINF_SUCCESS;
@@ -833 +821 @@
     if (RT_LIKELY(pPdmDev))
     {
-        TSTDEVDUTINT Dut;
-        Dut.pTestcaseReg    = &s_TestcaseDef;
-        Dut.enmCtx          = TSTDEVDUTCTX_R3;
-        Dut.pVm             = NULL;
-        Dut.SupSession.pDut = &Dut;
-        RTListInit(&Dut.LstIoPorts);
-        RTListInit(&Dut.LstTimers);
-        RTListInit(&Dut.LstMmHeap);
-        RTListInit(&Dut.LstPdmThreads);
-        RTListInit(&Dut.SupSession.LstSupSem);
-        CFGMNODE Cfg;
-        Cfg.pDut = &Dut;
-
-        rc = RTCritSectRwInit(&Dut.CritSectLists);
-        AssertRC(rc);
-
-        rc = RTCritSectInitEx(&Dut.CritSectNop.s.CritSect, RTCRITSECT_FLAGS_NOP, NIL_RTLOCKVALCLASS, RTLOCKVAL_SUB_CLASS_NONE, "DutNop");
-        AssertRC(rc);
-
         PPDMCRITSECT pCritSect;
         /* Figure out how much we need. */
@@ -872 +841 @@
         pDevIns->pvInstanceDataR3         = &pDevIns->achInstanceData[0];
         pDevIns->pHlpR3                   = &g_tstDevPdmDevHlpR3;
-        pDevIns->pCfg                     = &Cfg;
-        pDevIns->Internal.s.pDut          = &Dut;
+        pDevIns->pCfg                     = &pDut->Cfg;
+        pDevIns->Internal.s.pDut          = pDut;
         pDevIns->cbRing3                  = cb;
-        //pDevIns->fR0Enabled             = false;
-        //pDevIns->fRCEnabled             = false;
+        pDevIns->fR0Enabled               = fR0Enabled;
+        pDevIns->fRCEnabled               = fRCEnabled;
         pDevIns->pvInstanceDataR3         = (uint8_t *)pDevIns + offShared;
         pDevIns->pvInstanceDataForR3      = &pDevIns->achInstanceData[0];
@@ -894 +863 @@
         }
 
-        rc = pPdmDev->pReg->pfnConstruct(pDevIns, 0, &Cfg);
+        rc = pPdmDev->pReg->pfnConstruct(pDevIns, 0, pDevIns->pCfg);
         if (RT_SUCCESS(rc))
-        {
-            PRTDEVDUTIOPORT pIoPort = RTListGetFirst(&Dut.LstIoPorts, RTDEVDUTIOPORT, NdIoPorts);
-            uint32_t uVal = 0;
-            /*PDMCritSectEnter(pDevIns->pCritSectRoR3, VERR_IGNORED);*/
-            pIoPort->pfnInR0(pDevIns, pIoPort->pvUserR0, pIoPort->PortStart, &uVal, sizeof(uint8_t));
-            /*PDMCritSectLeave(pDevIns->pCritSectRoR3);*/
+            pDut->pDevIns = pDevIns;
+        else
+        {
+            rc = pPdmDev->pReg->pfnDestruct(pDevIns);
+            RTMemFree(pDevIns);
         }
     }
@@ -909 +877 @@
     return rc;
 }
+
+
+/**
+ * Run a given test config.
+ *
+ * @returns VBox status code.
+ * @param   pDevTstCfg          The test config to run.
+ */
+static int tstDevTestsRun(PCTSTDEVCFG pDevTstCfg)
+{
+    int rc = VINF_SUCCESS;
+
+    for (uint32_t i = 0; i < pDevTstCfg->cTests; i++)
+    {
+        PCTSTDEVTEST pTest = &pDevTstCfg->aTests[i];
+
+        TSTDEVDUTINT Dut;
+        Dut.pTest           = pTest;
+        Dut.enmCtx          = TSTDEVDUTCTX_R3;
+        Dut.pVm             = NULL;
+        Dut.SupSession.pDut = &Dut;
+        Dut.Cfg.pDut        = &Dut;
+        RTListInit(&Dut.LstIoPorts);
+        RTListInit(&Dut.LstTimers);
+        RTListInit(&Dut.LstMmHeap);
+        RTListInit(&Dut.LstPdmThreads);
+        RTListInit(&Dut.LstSsmHandlers);
+        RTListInit(&Dut.SupSession.LstSupSem);
+
+        rc = RTCritSectRwInit(&Dut.CritSectLists);
+        AssertRC(rc);
+
+        rc = RTCritSectInitEx(&Dut.CritSectNop.s.CritSect, RTCRITSECT_FLAGS_NOP, NIL_RTLOCKVALCLASS, RTLOCKVAL_SUB_CLASS_NONE, "DutNop");
+        AssertRC(rc);
+
+        rc = tstDevPdmDevCreate(pDevTstCfg->pszDevName, pTest->fR0Enabled, pTest->fRCEnabled, &Dut);
+        if (RT_SUCCESS(rc))
+        {
+            /** @todo Next */
+        }
+    }
+
+    return rc;
+}
+
 
 int main(int argc, char *argv[])
@@ -924 +937 @@
         RTListInit(&g_LstPdmDevs);
 
-        rc = tstDevLoadPlugin("TSTDevTestcases");
-        if (RT_SUCCESS(rc) || true)
-        {
-            rc = tstDevPdmLoadMod(argv[1], TSTDEVPDMMODTYPE_R3);
+        PCTSTDEVCFG pDevTstCfg = NULL;
+        rc = tstDevCfgLoad(argv[1], NULL, &pDevTstCfg);
+        if (RT_SUCCESS(rc))
+        {
+            if (pDevTstCfg->pszTstDevMod)
+                rc = tstDevLoadPlugin(pDevTstCfg->pszTstDevMod);
             if (RT_SUCCESS(rc))
-                rc = tstDevPdmDevCreate("serial");
+            {
+                rc = tstDevPdmLoadMod(pDevTstCfg->pszPdmR3Mod, TSTDEVPDMMODTYPE_R3);
+                if (   RT_SUCCESS(rc)
+                    && pDevTstCfg->pszPdmR0Mod)
+                    rc = tstDevPdmLoadMod(pDevTstCfg->pszPdmR0Mod, TSTDEVPDMMODTYPE_R0);
+                if (   RT_SUCCESS(rc)
+                    && pDevTstCfg->pszPdmRCMod)
+                    rc = tstDevPdmLoadMod(pDevTstCfg->pszPdmRCMod, TSTDEVPDMMODTYPE_RC);
+
+                if (RT_SUCCESS(rc))
+                    rc = tstDevTestsRun(pDevTstCfg);
+                else
+                    rcExit = RTEXITCODE_FAILURE;
+            }
             else
                 rcExit = RTEXITCODE_FAILURE;
         }
-        else
-            rcExit = RTEXITCODE_FAILURE;
-
-        //rcExit = tstDevParseOptions(argc, argv);
+
+        tstDevCfgDestroy(pDevTstCfg);
     }
     else

trunk/src/VBox/Devices/testcase/tstDeviceInternal.h

@@ -28 +28 @@
 #include <iprt/critsect.h>
 
+#include "tstDeviceCfg.h"
 #include "tstDevicePlugin.h"
 
@@ -330 +331 @@
 typedef struct TSTDEVDUTINT
 {
-    /** Pointer to the testcase this device is part of. */
-    PCTSTDEVTESTCASEREG             pTestcaseReg;
+    /** Pointer to the test this device is running under. */
+    PCTSTDEVTEST                    pTest;
     /** Pointer to the PDM device instance. */
     PPDMDEVINS                      pDevIns;
+    /** CFGM root config node for the device. */
+    CFGMNODE                        Cfg;
     /** Current device context. */
     TSTDEVDUTCTX                    enmCtx;

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

@@ -78 +78 @@
  * @returns VBox status code.
  * @param   paDevCfg        The array of config items.
+ * @param   cCfgItems       Number of config items in the array.
  * @param   pszName         Name of a byte string value.
  * @param   ppItem          Where to store the pointer to the item.
  */
-static int tstDev_CfgmR3ResolveItem(PCTSTDEVCFGITEM paDevCfg, const char *pszName, PCTSTDEVCFGITEM *ppItem)
+static int tstDev_CfgmR3ResolveItem(PCTSTDEVCFGITEM paDevCfg, uint32_t cCfgItems, const char *pszName, PCTSTDEVCFGITEM *ppItem)
 {
     *ppItem = NULL;
@@ -89 +90 @@
     size_t          cchName = strlen(pszName);
     PCTSTDEVCFGITEM pDevCfgItem = paDevCfg;
-    while (pDevCfgItem->pszKey != NULL)
+
+    for (uint32_t i = 0; i < cCfgItems; i++)
     {
         size_t cchKey = strlen(pDevCfgItem->pszKey);
@@ -1436 +1438 @@
 
     PCTSTDEVCFGITEM pCfgItem;
-    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTestcaseReg->paDevCfg, pszName, &pCfgItem);
+    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTest->paCfgItems, pNode->pDut->pTest->cCfgItems, pszName, &pCfgItem);
     if (RT_SUCCESS(rc))
     {
@@ -1446 +1448 @@
 
             case TSTDEVCFGITEMTYPE_STRING:
-                *pcb = strlen(pCfgItem->pszVal) + 1;
+                *pcb = strlen(pCfgItem->u.psz) + 1;
                 break;
 
@@ -1469 +1471 @@
 
     PCTSTDEVCFGITEM pCfgItem;
-    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTestcaseReg->paDevCfg, pszName, &pCfgItem);
+    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTest->paCfgItems, pNode->pDut->pTest->cCfgItems, pszName, &pCfgItem);
     if (RT_SUCCESS(rc))
     {
         if (pCfgItem->enmType == TSTDEVCFGITEMTYPE_INTEGER)
-            *pu64 = RTStrToUInt64(pCfgItem->pszVal);
+            *pu64 = (uint64_t)pCfgItem->u.i64;
         else
             rc = VERR_CFGM_NOT_INTEGER;
@@ -1502 +1504 @@
 
     PCTSTDEVCFGITEM pCfgItem;
-    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTestcaseReg->paDevCfg, pszName, &pCfgItem);
+    int rc = tstDev_CfgmR3ResolveItem(pNode->pDut->pTest->paCfgItems, pNode->pDut->pTest->cCfgItems, pszName, &pCfgItem);
     if (RT_SUCCESS(rc))
     {
@@ -1509 +1511 @@
             case TSTDEVCFGITEMTYPE_STRING:
             {
-                size_t cchVal = strlen(pCfgItem->pszVal);
+                size_t cchVal = strlen(pCfgItem->u.psz);
                 if (cchString <= cchVal + 1)
-                    memcpy(pszString, pCfgItem->pszVal, cchVal);
+                    memcpy(pszString, pCfgItem->u.psz, cchVal);
                 else
                     rc = VERR_CFGM_NOT_ENOUGH_SPACE;
@@ -2018 +2020 @@
 static DECLCALLBACK(bool) pdmR3DevHlp_CFGMAreValuesValid(PCFGMNODE pNode, const char *pszzValid)
 {
-    if (pNode && pNode->pDut->pTestcaseReg->paDevCfg)
+    if (pNode && pNode->pDut->pTest->paCfgItems)
     {
-        PCTSTDEVCFGITEM pDevCfgItem = pNode->pDut->pTestcaseReg->paDevCfg;
-        while (pDevCfgItem->pszKey != NULL)
+        PCTSTDEVCFGITEM pDevCfgItem = pNode->pDut->pTest->paCfgItems;
+        for (uint32_t i = 0; i < pNode->pDut->pTest->cCfgItems; i++)
         {
             size_t cchKey = strlen(pDevCfgItem->pszKey);

trunk/src/VBox/Devices/testcase/tstDevicePlugin.h

@@ -22 +22 @@
 
 #include <VBox/types.h>
-
-/**
- * Config item type.
- */
-typedef enum TSTDEVCFGITEMTYPE
-{
-    /** Invalid type. */
-    TSTDEVCFGITEMTYPE_INVALID = 0,
-    /** String type. */
-    TSTDEVCFGITEMTYPE_STRING,
-    /** Integer value encoded in the string. */
-    TSTDEVCFGITEMTYPE_INTEGER,
-    /** Raw bytes. */
-    TSTDEVCFGITEMTYPE_BYTES,
-    /** 32bit hack. */
-    TSTDEVCFGITEMTYPE_32BIT_HACK = 0x7fffffff
-} TSTDEVCFGITEMTYPE;
-/** Pointer to a config item type. */
-typedef TSTDEVCFGITEMTYPE *PTSTDEVCFGITEMTYPE;
-
-
-/**
- * Testcase config item.
- */
-typedef struct TSTDEVCFGITEM
-{
-    /** The key of the item. */
-    const char          *pszKey;
-    /** Type of the config item. */
-    TSTDEVCFGITEMTYPE   enmType;
-    /** The value of the item (as a string/number of bytes to make static
-     * instantiation easier). */
-    const char          *pszVal;
-} TSTDEVCFGITEM;
-/** Pointer to a testcase config item. */
-typedef TSTDEVCFGITEM *PTSTDEVCFGITEM;
-/** Pointer to a constant testcase config item. */
-typedef const TSTDEVCFGITEM *PCTSTDEVCFGITEM;
-
 
 /** Device under test handle. */