Changeset 12635 in vbox for trunk/src

Timestamp:

Sep 22, 2008 12:49:48 PM (16 years ago)

Author:

vboxsync

Message:

#1865: CFGM.

Location:

trunk/src/VBox/VMM

Files:

• CFGM.cpp (modified) (7 diffs)
• CFGMInternal.h (modified) (2 diffs)

trunk/src/VBox/VMM/CFGM.cpp

@@ -22 +22 @@
 /** @page pg_cfgm       CFGM - The Configuration Manager
  *
- * The configuration manager is responsible for storing the configuration
- * of the VM at run time. It is organized a bit like file hierarchy,
- * except that the values live in a separate name space, i.e. value names
- * can include path separators.
- *
- * The VMM user creates the configuration tree as part of the VMR3Create()
- * call via the pfnCFGMConstructor callback argument. If this isn't specified
- * a simple default tree is created by cfgmR3CreateDefaultTree(). When used
- * in the normal setup, this function is found in Main/ConsoleImpl2.cpp.
- * For the VBoxBFE case, see the VBoxBFE.cpp.
+ * The configuration manager is a directory containing the VM configuration at
+ * run time. It works in a manner similar to the windows registry - it's like a
+ * file system hierarchy, but the files (values) live in a separate name space
+ * and can include the path separators.
+ *
+ * The configuration is normally created via a callback passed to VMR3Create()
+ * via the pfnCFGMConstructor parameter. To make testcase writing a bit simpler,
+ * we allow the callback to be NULL, in which case a simple default
+ * configuration will be created by cfgmR3CreateDefaultTree(). The
+ * Console::configConstructor() method in Main/ConsoleImpl2.cpp creates the
+ * configuration from the XML.
  *
  * Devices, drivers, services and other PDM stuff are given their own subtree
@@ -37 +38 @@
  * is implemented via the CFGMR3SetRestrictedRoot() API.
  *
- * Validating of the data obtained, except for validation of the primitive
- * type, is left the caller. The caller is in a better position to know the
- * proper validation rules of the individual properties.
+ * Data validation out over the basic primitives is left to the caller. The
+ * caller is in a better position to know the proper validation rules of the
+ * individual properties.
  *
  *
@@ -49 +50 @@
  *      - Zero terminated character strings. These are of course UTF-8.
  *      - Variable length byte strings. This can be used to get/put binary
- *        objects.
+ *        objects like for instance RTMAC.
  *
  */
@@ -93 +94 @@
  *                              This is called in the EM.
  * @param   pvUser              The user argument passed to pfnCFGMConstructor.
+ * @thread  EMT.
  */
 CFGMR3DECL(int) CFGMR3Init(PVM pVM, PFNCFGMCONSTRUCTOR pfnCFGMConstructor, void *pvUser)
@@ -101 +103 @@
      * Init data members.
      */
-    pVM->cfgm.s.offVM = RT_OFFSETOF(VM, cfgm);
     pVM->cfgm.s.pRoot = NULL;
 
@@ -136 +137 @@
         Log(("CFGMR3Init: Successfully constructed the configuration\n"));
         CFGMR3Dump(CFGMR3GetRoot(pVM));
-
     }
     else
@@ -154 +154 @@
 {
     CFGMR3RemoveNode(pVM->cfgm.s.pRoot);
+    pVM->cfgm.s.pRoot = NULL;
     return 0;
 }

trunk/src/VBox/VMM/CFGMInternal.h

@@ -121 +121 @@
 
 
-
-/**
- * Converts a CFGM pointer into a VM pointer.
- * @returns Pointer to the VM structure the CFGM is part of.
- * @param   pCFGM   Pointer to CFGM instance data.
- */
-#define CFGM2VM(pCFGM)  ( (PVM)((char*)pCFGM - pCFGM->offVM) )
-
 /**
  * CFGM VM Instance data.
@@ -135 +127 @@
 typedef struct CFGM
 {
-    /** Offset to the VM structure.
-     * See CFGM2VM(). */
-    RTUINT                  offVM;
-    /** Alignment padding. */
-    RTUINT                  uPadding0;
-
     /** Pointer to root node. */
     R3PTRTYPE(PCFGMNODE)    pRoot;