Changeset 53435 in vbox

Timestamp:

Dec 3, 2014 6:03:25 PM (10 years ago)

Author:

vboxsync

Message:

VBox/sup.h: r=bird: Try unbreak non-x86/amd64 use of the header (busted by r96760 and compounded in 97118). Doc + codestyle changes: 1. Brief function/whatever description should stand alone and be, well, brief. Ofthen you only want to get clued in on what the function does, not read about all the pitfalls and stuff. 2. No 'else' after 'return'.

File:

• trunk/include/VBox/sup.h (modified) (13 diffs)

trunk/include/VBox/sup.h

@@ -33 +33 @@
 #include <iprt/stdarg.h>
 #include <iprt/cpuset.h>
-#include <iprt/asm-amd64-x86.h>
+#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
+# include <iprt/asm-amd64-x86.h>
+#endif
 
 RT_C_DECLS_BEGIN
@@ -427 +429 @@
 SUPDECL(PSUPGLOBALINFOPAGE)             SUPGetGIP(void);
 
-
+#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
 /**
  * Gets the TSC frequency of the calling CPU.
@@ -448 +450 @@
         Assert(pGip->u32Mode == SUPGIPMODE_ASYNC_TSC);
         iCpu = pGip->aiCpuFromApicId[ASMGetApicId()];
-        if (iCpu >= pGip->cCpus)
+        if (RT_UNLIKELY(iCpu >= pGip->cCpus))
             return UINT64_MAX;
     }
@@ -454 +456 @@
     return pGip->aCPUs[iCpu].u64CpuHz;
 }
-
+#endif /* X86 || AMD64 */
 
 /**
@@ -1483 +1485 @@
     switch (pGip->u32Mode)
     {
-        case SUPGIPMODE_INVARIANT_TSC: return "Invariant";
-        case SUPGIPMODE_SYNC_TSC:      return "Synchronous";
-        case SUPGIPMODE_ASYNC_TSC:     return "Asynchronous";
-        case SUPGIPMODE_INVALID:       return "Invalid";
-        default:                       return "???";
+        case SUPGIPMODE_INVARIANT_TSC:  return "Invariant";
+        case SUPGIPMODE_SYNC_TSC:       return "Synchronous";
+        case SUPGIPMODE_ASYNC_TSC:      return "Asynchronous";
+        case SUPGIPMODE_INVALID:        return "Invalid";
+        default:                        return "???";
     }
 }
@@ -1504 +1506 @@
         && pGip->u32Mode == SUPGIPMODE_INVARIANT_TSC)
     {
-        uint64_t uLo;
-        uint64_t uHi;
-
-        if (pGip->u64CpuHz == u64CpuHz)
-            return true;
-
-        /* Arbitrary tolerance threshold, tweak later if required, perhaps
-           more tolerance on lower frequencies and less tolerance on higher. */
-        uLo = (pGip->u64CpuHz << 10) / 1025;
-        uHi = pGip->u64CpuHz + (pGip->u64CpuHz - uLo);
-        if (   u64CpuHz < uLo
-            || u64CpuHz > uHi)
-            return false;
+        if (pGip->u64CpuHz != u64CpuHz)
+        {
+            /* Arbitrary tolerance threshold, tweak later if required, perhaps
+               more tolerance on lower frequencies and less tolerance on higher. */
+            uint64_t uLo = (pGip->u64CpuHz << 10) / 1025;
+            uint64_t uHi = pGip->u64CpuHz + (pGip->u64CpuHz - uLo);
+            if (   u64CpuHz < uLo
+                || u64CpuHz > uHi)
+                return false;
+        }
         return true;
     }
@@ -1522 +1521 @@
 }
 
+#if defined(RT_ARCH_AMD64) || defined(RT_ARCH_X86)
 
 /**
@@ -1533 +1533 @@
  *                          applied or not (optional, can be NULL).
  *
- * @note If you change the delta calculation made here, make sure to update the
- *       assembly version in sup.mac! Also update supdrvGipMpEvent() while
- *       re-adjusting deltas while choosing a new GIP master.
  * @remarks Maybe called with interrupts disabled in ring-0!
+ *
+ * @note    If you change the delta calculation made here, make sure to update
+ *          the assembly version in sup.mac! Also update supdrvGipMpEvent()
+ *          while re-adjusting deltas while choosing a new GIP master.
  */
 DECLINLINE(int) SUPTscDeltaApply(PSUPGLOBALINFOPAGE pGip, uint64_t *puTsc, uint16_t idApic, bool *pfDeltaApplied)
@@ -1567 +1568 @@
 
 /**
- * Gets the delta-adjusted TSC, must only be called when GIP mode is invariant
- * (i.e. when TSC deltas are likely to be computed and available).
- *
- * In other GIP modes, like async, we don't bother with computing TSC deltas and
- * therefore it is meaningless to call this function, use SUPReadTSC() instead.
+ * Gets the delta-adjusted TSC.
+ *
+ * Must only be called when GIP mode is invariant (i.e. when TSC deltas are
+ * likely to be computed and available).  In other GIP modes, like async, we
+ * don't bother with computing TSC deltas and therefore it is meaningless to
+ * call this function, use SUPReadTSC() instead.
  *
  * @returns VBox status code.
@@ -1585 +1587 @@
 DECLINLINE(int) SUPGetTsc(uint64_t *puTsc, uint16_t *pidApic)
 {
-#ifdef IN_RING3
+# ifdef IN_RING3
     return SUPR3ReadTsc(puTsc, pidApic);
-#else
+# else
     RTCCUINTREG uFlags;
     uint16_t    idApic;
@@ -1607 +1609 @@
     AssertRCReturn(rc, rc);
     return fDeltaApplied ? VINF_SUCCESS : VERR_SUPDRV_TSC_READ_FAILED;
-#endif
+# endif
 }
 
@@ -1613 +1615 @@
 /**
  * Reads the host TSC value.
+ *
  * If applicable, normalizes the host TSC value with intercpu TSC deltas.
  *
@@ -1628 +1631 @@
         return u64Tsc;
     }
-    else
-        return ASMReadTSC();
+    return ASMReadTSC();
 }
+
+#endif /* X86 || AMD64 */