Changeset 64497 in vbox

Timestamp:

Nov 1, 2016 4:38:06 AM (8 years ago)

Author:

vboxsync

Message:

PDMDriver.cpp Corrected driver transformation value name 'Driver' to 'Device' since it's actually matching the device name and not the driver (that's matched by 'AboveDriver'). Also added some docs to the basic keys and value involved in driver chain transformations.

File:

• trunk/src/VBox/VMM/VMMR3/PDMDriver.cpp (modified) (5 diffs)

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

@@ -425 +425 @@
         AssertLogRelRCReturn(rc, rc);
 
-        /* Match against the driver multi pattern. */
+        /** @cfgm{/PDM/DriverTransformations/<name>/Device,string,*}
+         * One or more simple wildcard patters separated by '|' for matching
+         * the devices this transformation rule applies to. */
         char *pszMultiPat;
-        rc = CFGMR3QueryStringAllocDef(pCurTrans, "Driver", &pszMultiPat, "*");
+        rc = CFGMR3QueryStringAllocDef(pCurTrans, "Device", &pszMultiPat, "*");
         AssertLogRelRCReturn(rc, rc);
         bool fMatch = RTStrSimplePatternMultiMatch(pszMultiPat, RTSTR_MAX, pszDevice, RTSTR_MAX, NULL);
@@ -434 +436 @@
             continue;
 
-        /* Match against the lun multi pattern. */
+        /** @cfgm{/PDM/DriverTransformations/<name>/LUN,string,*}
+         * One or more simple wildcard patters separated by '|' for matching
+         * the LUNs this transformation rule applies to. */
         rc = CFGMR3QueryStringAllocDef(pCurTrans, "LUN", &pszMultiPat, "*");
         AssertLogRelRCReturn(rc, rc);
@@ -442 +446 @@
             continue;
 
-        /* Match against the below-driver multi pattern. */
+        /** @cfgm{/PDM/DriverTransformations/<name>/BelowDriver,string,*}
+         * One or more simple wildcard patters separated by '|' for matching the
+         * drivers the transformation should be applied below.  This means, that
+         * when the drivers matched here attached another driver below them, the
+         * transformation will be applied.  To represent the device, '<top>' is
+         * used. */
         rc = CFGMR3QueryStringAllocDef(pCurTrans, "BelowDriver", &pszMultiPat, "*");
         AssertLogRelRCReturn(rc, rc);
@@ -450 +459 @@
             continue;
 
-        /* Match against the above-driver multi pattern. */
+        /** @cfgm{/PDM/DriverTransformations/<name>/AboveDriver,string,*}
+         * One or more simple wildcard patters separated by '|' for matching the
+         * drivers the transformation should be applie above or at (depending on
+         * the action).  The value being matched against here is the driver that
+         * is in the process of being attached, so for mergeconfig actions this is
+         * usually what you need to match on. */
         rc = CFGMR3QueryStringAlloc(pCurTrans, "AboveDriver", &pszMultiPat);
         if (rc == VERR_CFGM_VALUE_NOT_FOUND)
@@ -467 +481 @@
         /*
          * We've got a match! Now, what are we supposed to do?
+         */
+        /** @cfgm{/PDM/DriverTransformations/<name>/Action,string,inject}
+         * The action that the the transformation takes.  Possible values are:
+         *      - inject
+         *      - mergeconfig: This merges and the content of the 'Config' key under the
+         *        transformation into the driver's own 'Config' key, replacing any
+         *        duplicates.
+         *      - remove
+         *      - removetree
+         *      - replace
+         *      - replacetree
          */
         char szAction[16];