Changeset 39839 in vbox for trunk/src/VBox

Timestamp:

Jan 23, 2012 4:05:57 PM (13 years ago)

Author:

vboxsync

Message:

PDM: Initial driver chain transformation code (untested).

Location:

trunk/src/VBox/VMM

Files:

• VMMR3/PDM.cpp (modified) (3 diffs)
• VMMR3/PDMDevice.cpp (modified) (1 diff)
• VMMR3/PDMDriver.cpp (modified) (3 diffs)
• VMMR3/PDMUsb.cpp (modified) (1 diff)
• include/PDMInternal.h (modified) (2 diffs)

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

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2007 Oracle Corporation
+ * Copyright (C) 2006-2012 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -267 +267 @@
 #include <iprt/assert.h>
 #include <iprt/alloc.h>
+#include <iprt/ctype.h>
 #include <iprt/ldr.h>
 #include <iprt/path.h>
@@ -2360 +2361 @@
 }
 
+
+/**
+ * Checks that a PDMDRVREG::szName, PDMDEVREG::szName or PDMUSBREG::szName
+ * field contains only a limited set of ASCII characters.
+ *
+ * @returns true / false.
+ * @param   pszName             The name to validate.
+ */
+bool pdmR3IsValidName(const char *pszName)
+{
+    char ch;
+    while (   (ch = *pszName) != '\0'
+           && (   RT_C_IS_ALNUM(ch)
+               || ch == '-'
+               || ch == ' ' /** @todo disallow this! */
+               || ch == '_') )
+        pszName++;
+    return ch == '\0';
+}
+

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

@@ -631 +631 @@
 
     AssertMsgReturn(    pReg->szName[0]
-                    &&  strlen(pReg->szName) < sizeof(pReg->szName),
-                    ("Invalid name '%s'\n", pReg->szName),
+                    &&  strlen(pReg->szName) < sizeof(pReg->szName)
+                    &&  pdmR3IsValidName(pReg->szName),
+                    ("Invalid name '%.s'\n", sizeof(pReg->szName), pReg->szName),
                     VERR_PDM_INVALID_DEVICE_REGISTRATION);
     AssertMsgReturn(   !(pReg->fFlags & PDM_DEVREG_FLAGS_RC)

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

@@ -270 +270 @@
     AssertReturn(pReg->szName[0], VERR_PDM_INVALID_DRIVER_REGISTRATION);
     AssertMsgReturn(RTStrEnd(pReg->szName, sizeof(pReg->szName)),
-                    (".*s\n", sizeof(pReg->szName), pReg->szName),
+                    ("%.*s\n", sizeof(pReg->szName), pReg->szName),
+                    VERR_PDM_INVALID_DRIVER_REGISTRATION);
+    AssertMsgReturn(pdmR3IsValidName(pReg->szName), ("%.*s\n", pReg->szName),
                     VERR_PDM_INVALID_DRIVER_REGISTRATION);
     AssertMsgReturn(    !(pReg->fFlags & PDM_DRVREG_FLAGS_R0)
@@ -370 +372 @@
 
 /**
+ * Transforms the driver chain as it's being instantiated.
+ *
+ * Worker for pdmR3DrvInstantiate.
+ *
+ * @returns VBox status code.
+ * @param   pVM                 The VM handle.
+ * @param   pDrvAbove           The driver above, NULL if top.
+ * @param   pLun                The LUN.
+ * @param   ppNode              The AttachedDriver node, replaced if any
+ *                              morphing took place.
+ */
+static int pdmR3DrvMaybeTransformChain(PVM pVM, PPDMDRVINS pDrvAbove, PPDMLUN pLun, PCFGMNODE *ppNode)
+{
+    /*
+     * The typical state of affairs is that there are no injections.
+     */
+    PCFGMNODE pCurTrans = CFGMR3GetFirstChild(CFGMR3GetChild(CFGMR3GetRoot(pVM), "PDM/DriverTransformations"));
+    if (!pCurTrans)
+        return VINF_SUCCESS;
+
+    /*
+     * Gather the attributes used in the matching process.
+     */
+    const char *pszDevice = pLun->pDevIns->Internal.s.pDevR3->pReg->szName;
+    char        szLun[32];
+    RTStrPrintf(szLun, sizeof(szLun), "%u", pLun->iLun);
+    const char *pszAbove  = pDrvAbove ? pDrvAbove->Internal.s.pDrv->pReg->szName : "<top>";
+    char       *pszThisDrv;
+    int rc = CFGMR3QueryStringAlloc(*ppNode, "Driver", &pszThisDrv);
+    AssertMsgRCReturn(rc,  ("Query for string value of \"Driver\" -> %Rrc\n", rc),
+                      rc == VERR_CFGM_VALUE_NOT_FOUND ? VERR_PDM_CFG_MISSING_DRIVER_NAME : rc);
+
+
+    /*
+     * Enumerate possible driver chain transformations.
+     */
+    for (; pCurTrans != NULL; pCurTrans = CFGMR3GetNextChild(pCurTrans))
+    {
+        /* Match against the driver multi pattern. */
+        char *pszMultiPat;
+        rc = CFGMR3QueryStringAllocDef(pCurTrans, "Driver", &pszMultiPat, "*");
+        AssertLogRelRCReturn(rc, rc);
+        bool fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszDevice, RTSTR_MAX, NULL);
+        MMR3HeapFree(pszMultiPat);
+        if (!fMatch)
+            continue;
+
+        /* Match against the lun multi pattern. */
+        rc = CFGMR3QueryStringAllocDef(pCurTrans, "LUN", &pszMultiPat, "*");
+        AssertLogRelRCReturn(rc, rc);
+        fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, szLun, RTSTR_MAX, NULL);
+        MMR3HeapFree(pszMultiPat);
+        if (!fMatch)
+            continue;
+
+        /* Match against the below-driver multi pattern. */
+        rc = CFGMR3QueryStringAllocDef(pCurTrans, "BelowDriver", &pszMultiPat, "*");
+        AssertLogRelRCReturn(rc, rc);
+        fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszAbove, RTSTR_MAX, NULL);
+        MMR3HeapFree(pszMultiPat);
+        if (!fMatch)
+            continue;
+
+        /* Match against the above-driver multi pattern. */
+        /** @todo add some config to avoid infinie application of an
+         * AboveDriver transformation. */
+        rc = CFGMR3QueryStringAllocDef(pCurTrans, "AboveDriver", &pszMultiPat, "*");
+        AssertLogRelRCReturn(rc, rc);
+        fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszThisDrv, RTSTR_MAX, NULL);
+        MMR3HeapFree(pszMultiPat);
+        if (!fMatch)
+            continue;
+
+        /*
+         * We've got a match! Now, what are we supposed to do?
+         */
+        char szAction[16];
+        rc = CFGMR3QueryStringDef(pCurTrans, "Action", szAction, sizeof(szAction), "inject");
+        AssertLogRelRCReturn(rc, rc);
+        AssertLogRelMsgFailedReturn(("Action='%s', valid values are 'inject', 'replace' and 'remove'.\n",  szAction),
+                                    VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
+
+        AssertLogRelMsgReturn(   !strcmp(szAction, "inject")
+                              || !strcmp(szAction, "replace")
+                              || !strcmp(szAction, "remove"),
+                              ("Action='%s', valid values are 'inject', 'replace' and 'remove'.\n",  szAction),
+                              VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
+
+        /* Get the attached driver to inject. */
+        PCFGMNODE pTransAttDrv = NULL;
+        if (!strcmp(szAction, "inject") || !strcmp(szAction, "replace"))
+        {
+            pTransAttDrv = CFGMR3GetChild(pCurTrans, "AttachedDriver");
+            AssertLogRelMsgReturn(pTransAttDrv,
+                                  ("An %s transformation requires an AttachedDriver child node!\n", szAction),
+                                  VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION);
+        }
+
+
+        /*
+         * Remove the node.
+         */
+        if (!strcmp(szAction, "remove"))
+        {
+            PCFGMNODE pBelowThis = CFGMR3GetChild(*ppNode, "AttachedDriver");
+            if (pBelowThis)
+            {
+                PCFGMNODE pBelowThisCopy = CFGMR3DuplicateSubTree(pBelowThis);
+                AssertLogRelReturn(pBelowThisCopy, VERR_NO_MEMORY);
+
+                rc = CFGMR3ReplaceSubTree(*ppNode, pBelowThisCopy);
+                if (RT_FAILURE(rc))
+                {
+                    CFGMR3RemoveNode(pBelowThis);
+                    AssertLogRelReturn(("rc=%Rrc\n", rc), rc);
+                }
+            }
+            else
+            {
+                CFGMR3RemoveNode(*ppNode);
+                *ppNode = NULL;
+            }
+        }
+        /*
+         * Replace the driver about to be instantiated.
+         */
+        else if (!strcmp(szAction, "replace"))
+        {
+            PCFGMNODE pTransCopy = CFGMR3DuplicateSubTree(pTransAttDrv);
+            AssertLogRelBreakStmt(pTransCopy, rc = VERR_NO_MEMORY);
+            rc = VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION;
+
+            PCFGMNODE pBelowThis = CFGMR3GetChild(*ppNode, "AttachedDriver");
+            if (!pBelowThis)
+                rc = VINF_SUCCESS;
+            else
+            {
+                PCFGMNODE pBelowThisCopy = CFGMR3DuplicateSubTree(pBelowThis);
+                if (pBelowThisCopy)
+                {
+                    rc = CFGMR3InsertSubTree(pTransCopy, "AttachedDriver", pBelowThisCopy, NULL);
+                    AssertLogRelRC(rc);
+                    if (RT_FAILURE(rc))
+                        CFGMR3RemoveNode(pBelowThisCopy);
+                }
+            }
+            if (RT_SUCCESS(rc))
+                rc = CFGMR3ReplaceSubTree(*ppNode, pTransCopy);
+            if (RT_FAILURE(rc))
+                CFGMR3RemoveNode(pTransCopy);
+        }
+        /*
+         * Inject a driver before the driver about to be instantiated.
+         */
+        else if (!strcmp(szAction, "inject"))
+        {
+            PCFGMNODE pTransCopy = CFGMR3DuplicateSubTree(pTransAttDrv);
+            AssertLogRelBreakStmt(pTransCopy, rc = VERR_NO_MEMORY);
+            rc = VERR_PDM_MISCONFIGURED_DRV_TRANSFORMATION;
+
+            PCFGMNODE pThisCopy = CFGMR3DuplicateSubTree(*ppNode);
+            if (pThisCopy)
+            {
+                rc = CFGMR3InsertSubTree(pTransCopy, "AttachedDriver", pThisCopy, NULL);
+                AssertLogRelRC(rc);
+                if (RT_FAILURE(rc))
+                    CFGMR3RemoveNode(pThisCopy);
+            }
+            if (RT_SUCCESS(rc))
+                rc = CFGMR3ReplaceSubTree(*ppNode, pTransCopy);
+            if (RT_FAILURE(rc))
+                CFGMR3RemoveNode(pTransCopy);
+        }
+        else
+            AssertFailed();
+        break;
+    }
+
+    return rc;
+}
+
+
+/**
  * Instantiate a driver.
  *
@@ -397 +582 @@
 
     /*
+     * Do driver chain injections
+     */
+    int rc = pdmR3DrvMaybeTransformChain(pVM, pDrvAbove, pLun, &pNode);
+    if (RT_FAILURE(rc))
+        return rc;
+
+    /*
      * Find the driver.
      */
     char *pszName;
-    int rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
+    rc = CFGMR3QueryStringAlloc(pNode, "Driver", &pszName);
     if (RT_SUCCESS(rc))
     {

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

@@ -222 +222 @@
                     VERR_PDM_UNKNOWN_USBREG_VERSION);
     AssertMsgReturn(    pReg->szName[0]
-                    &&  strlen(pReg->szName) < sizeof(pReg->szName),
-                    ("Invalid name '%s'\n", pReg->szName),
+                    &&  strlen(pReg->szName) < sizeof(pReg->szName)
+                    &&  pdmR3IsValidName(pReg->szName),
+                    ("Invalid name '%.s'\n", sizeof(pReg->szName), pReg->szName),
                     VERR_PDM_INVALID_USB_REGISTRATION);
     AssertMsgReturn(pReg->fFlags == 0, ("fFlags=%#x\n", pReg->fFlags), VERR_PDM_INVALID_USB_REGISTRATION);

trunk/src/VBox/VMM/include/PDMInternal.h

@@ -1124 +1124 @@
 *******************************************************************************/
 #ifdef IN_RING3
+bool        pdmR3IsValidName(const char *pszName);
+
 int         pdmR3CritSectInitStats(PVM pVM);
 void        pdmR3CritSectRelocate(PVM pVM);
@@ -1193 +1195 @@
 
 #endif
+