Changeset 3978 in vbox for trunk/include

Timestamp:

Aug 2, 2007 12:39:19 AM (17 years ago)

Author:

vboxsync

Message:

Extended the RTTimerCreateEx interface by defining some flags for specifying the CPU(s) the timer should run on.

File:

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

trunk/include/iprt/timer.h

@@ -97 +97 @@
  *                              a recurring timer. This is rounded to the fit the system timer granularity.
  *                              For one shot timers, pass 0.
- * @param   fFlags              Timer flags. No flags has been defined yet, pass 0.
+ * @param   fFlags              Timer flags.
  * @param   pfnTimer            Callback function which shall be scheduled for execution
  *                              on every timer tick.
@@ -104 +104 @@
  */
 RTDECL(int) RTTimerCreateEx(PRTTIMER *ppTimer, uint64_t u64NanoInterval, unsigned fFlags, PFNRTTIMER pfnTimer, void *pvUser);
+
+/** @name RTTimerCreateEx flags
+ * @{ */
+/** Any CPU is fine. (Must be 0.) */
+#define RTTIMER_FLAGS_CPU_ANY        0
+/** One specific CPU */
+#define RTTIMER_FLAGS_CPU_SPECIFIC   BIT(8)
+/** All online CPUs. */
+#define RTTIMER_FLAGS_CPU_ALL        ( RTTIMER_FLAGS_CPU_MASK | RTTIMER_FLAGS_CPU_SPECIFIC )
+/** CPU mask. */
+#define RTTIMER_FLAGS_CPU_MASK       0xff
+/** Convert a CPU number (0-based) to RTTimerCreateEx flags. 
+ * This will automatically OR in the RTTIMER_FLAG_CPU_SPECIFIC flag. */
+#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)) )
+/** @} */
 
 /**