VBox

Timestamp:

Oct 23, 2015 9:16:36 PM (9 years ago)

Author:

vboxsync

Message:

VMM: Stubbed the csam, patm, rem and hm documentation @pages.

Location:

trunk/src/VBox/VMM/VMMR3

Files:

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

-              r58123
+              r58396
  */
+/** @page pg_csam   CSAM - Code Scanning Analysis Manager
+ *
+ * The CSAM is responsible for scanning and marking guest OS kernel code paths
+ * to making safe raw-mode execution possible.
+ *
+ * It works tightly with the @ref pg_patm "patch manager" to patch code
+ * sequences that we could otherwise not execute in raw-mode.
+ *
+ * @sa @ref grp_csam
+ */
 /*********************************************************************************************************************************

-              r58126
+              r58396
  */
+/** @page pg_hm     HM - Hardware Assisted Virtualization Manager
+ *
+ * The HM manages guest execution using the VT-x and AMD-V CPU hardware
+ * extensions.
+ *
+ * {summary of what HM does}
+ *
+ * Hardware assited virtualization manager was origianlly abriviated HWACCM,
+ * however that was cumbersome to write and parse for such a central component,
+ * so it was shorted to HM when refactoring the code in the 4.3 development
+ * cycle.
+ *
+ * {add sections with more details}
+ *
+ * @sa @ref grp_hm
+ */
 /*********************************************************************************************************************************

-              r58126
+              r58396
  */
+/** @page pg_patm   PATM - Patch Manager
+ *
+ * The patch manager (PATM) patches privileged guest code to allow it to execute
+ * directly in raw-mode.
+ *
+ * The PATM works closely together with the @ref pg_csam "CSAM" detect code
+ * needing patching and detected changes to the patch.  It also interfaces with
+ * other components, like @ref pg_trpm "TRPM" and @ref pg_rem "REM", for these
+ * purposes.
+ *
+ * @sa @ref grp_patm
+ */
 /*********************************************************************************************************************************

-              r58126
+              r58396
  * thing.  For hysterical reasons, it is not doing all the management that one
  * would expect, this is instead done by @ref pg_vm.  We'll address this
+ * misdesign eventually.
+ *
+ * @see grp_vmm, grp_vm
+ * misdesign eventually, maybe.
+ *
+ * VMM is made up of these components:
+ *  - @subpage pg_cfgm
+ *  - @subpage pg_cpum
+ *  - @subpage pg_csam
+ *  - @subpage pg_dbgf
+ *  - @subpage pg_em
+ *  - @subpage pg_gim
+ *  - @subpage pg_gmm
+ *  - @subpage pg_gvmm
+ *  - @subpage pg_hm
+ *  - @subpage pg_iem
+ *  - @subpage pg_iom
+ *  - @subpage pg_mm
+ *  - @subpage pg_patm
+ *  - @subpage pg_pdm
+ *  - @subpage pg_pgm
+ *  - @subpage pg_rem
+ *  - @subpage pg_selm
+ *  - @subpage pg_ssm
+ *  - @subpage pg_stam
+ *  - @subpage pg_trpm
+ *  - @subpage pg_vm
+ *
+ *
+ * @see @ref grp_vmm @ref grp_vm @subpage pg_vmm_guideline @subpage pg_raw
+ *
+ *

Note: See TracChangeset for help on using the changeset viewer.