Changeset 97242 in vbox for trunk/src/VBox

Timestamp:

Oct 20, 2022 6:00:20 AM (2 years ago)

Author:

vboxsync

Message:

VMM/PGM: Nested VMX: bugref:10092 Doxygen and comment update.

File:

• trunk/src/VBox/VMM/VMMAll/PGMAllGstSlatEpt.cpp.h (modified) (6 diffs)

trunk/src/VBox/VMM/VMMAll/PGMAllGstSlatEpt.cpp.h

@@ -30 +30 @@
 #endif
 
+/**
+ * Checks if the EPT PTE permissions are valid.
+ *
+ * @returns @c true if valid, @c false otherwise.
+ * @param   uEntry      The EPT page table entry to check.
+ * @param   uLevel      The page table walk level.
+ */
 DECLINLINE(bool) PGM_GST_SLAT_NAME_EPT(WalkIsPermValid)(PCVMCPUCC pVCpu, uint64_t uEntry)
 {
@@ -44 +51 @@
 
 
+/**
+ * Checks if the EPT memory type is valid.
+ *
+ * @returns @c true if valid, @c false otherwise.
+ * @param   uEntry      The EPT page table entry to check.
+ * @param   uLevel      The page table walk level.
+ */
 DECLINLINE(bool) PGM_GST_SLAT_NAME_EPT(WalkIsMemTypeValid)(uint64_t uEntry, uint8_t uLevel)
 {
@@ -61 +75 @@
 
 
+/**
+ * Updates page walk result info when a not-present page is encountered.
+ *
+ * @returns VERR_PAGE_TABLE_NOT_PRESENT.
+ * @param   pVCpu   The cross context virtual CPU structure of the calling EMT.
+ * @param   pWalk   The page walk info to update.
+ * @param   uEntry  The EPT PTE that is not present.
+ * @param   uLevel  The page table walk level.
+ */
 DECLINLINE(int) PGM_GST_SLAT_NAME_EPT(WalkReturnNotPresent)(PCVMCPUCC pVCpu, PPGMPTWALK pWalk, uint64_t uEntry, uint8_t uLevel)
 {
@@ -75 +98 @@
 
 
+/**
+ * Updates page walk result info when a bad physical address is encountered.
+ *
+ * @returns VERR_PAGE_TABLE_NOT_PRESENT .
+ * @param   pVCpu   The cross context virtual CPU structure of the calling EMT.
+ * @param   pWalk   The page walk info to update.
+ * @param   uLevel  The page table walk level.
+ * @param   rc      The error code that caused this bad physical address situation.
+ */
 DECLINLINE(int) PGM_GST_SLAT_NAME_EPT(WalkReturnBadPhysAddr)(PCVMCPUCC pVCpu, PPGMPTWALK pWalk, uint8_t uLevel, int rc)
 {
@@ -85 +117 @@
 
 
+/**
+ * Updates page walk result info when reserved bits are encountered.
+ *
+ * @returns VERR_PAGE_TABLE_NOT_PRESENT.
+ * @param   pVCpu   The cross context virtual CPU structure of the calling EMT.
+ * @param   pWalk   The page walk info to update.
+ * @param   uLevel  The page table walk level.
+ */
 DECLINLINE(int) PGM_GST_SLAT_NAME_EPT(WalkReturnRsvdError)(PVMCPUCC pVCpu, PPGMPTWALK pWalk, uint8_t uLevel)
 {
@@ -107 +147 @@
  *                              this page walk.
  * @param   GCPtrNested         The nested-guest linear address that caused this
- *                              page walk. If @c fIsLinearAddrValid is false, pass
+ *                              translation. If @c fIsLinearAddrValid is false, pass
  *                              0.
  * @param   pWalk               The page walk info.