Changeset 9444 in vbox for trunk/include/iprt/timer.h

Timestamp:

Jun 5, 2008 6:08:17 PM (16 years ago)

Author:

vboxsync

Message:

Added iTick to FNTIMER (the timer callback).

File:

• trunk/include/iprt/timer.h (modified) (3 diffs)

trunk/include/iprt/timer.h

@@ -78 +78 @@
  * @param   pTimer      Timer handle.
  * @param   pvUser      User argument.
- */
-typedef DECLCALLBACK(void) FNRTTIMER(PRTTIMER pTimer, void *pvUser);
+ * @param   iTick       The current timer tick. This is always 1 on the first
+ *                      callback after the timer was started. For omni timers
+ *                      this will be 1 when a cpu comes back online.
+ */
+typedef DECLCALLBACK(void) FNRTTIMER(PRTTIMER pTimer, void *pvUser, uint64_t iTick);
 /** Pointer to FNRTTIMER() function. */
 typedef FNRTTIMER *PFNRTTIMER;
@@ -122 +125 @@
 /** One specific CPU */
 #define RTTIMER_FLAGS_CPU_SPECIFIC   RT_BIT(8)
-/** All online CPUs. */
+/** Omni timer, run on all online CPUs.
+ * @remarks The timer callback isn't necessarily running at the time same time on each CPU. */
 #define RTTIMER_FLAGS_CPU_ALL        ( RTTIMER_FLAGS_CPU_MASK | RTTIMER_FLAGS_CPU_SPECIFIC )
 /** CPU mask. */
@@ -130 +134 @@
 #define RTTIMER_FLAGS_CPU(iCpu)      ( (iCpu) | RTTIMER_FLAG_CPU_SPECIFIC )
 /** Macro that validates the flags. */
-#define RTTIMER_FLAGS_IS_VALID(fFlags) ( !((fFlags) & ((fFlags) & RTTIMER_FLAGS_CPU_SPECIFIC ? 0x1ff : 0x100)) )
+#define RTTIMER_FLAGS_ARE_VALID(fFlags) ( !((fFlags) & ((fFlags) & RTTIMER_FLAGS_CPU_SPECIFIC ? 0x1ff : 0x100)) )
 /** @} */