Changeset 19386 in vbox for trunk/include/iprt

Timestamp:

May 5, 2009 3:54:19 PM (16 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

46893

Message:

iprt/mp.h: RTMpPokeCpu.

File:

• trunk/include/iprt/mp.h (modified) (1 diff)

trunk/include/iprt/mp.h

@@ -252 +252 @@
 RTDECL(int) RTMpOnSpecific(RTCPUID idCpu, PFNRTMPWORKER pfnWorker, void *pvUser1, void *pvUser2);
 
+/**
+ * Pokes the specified CPU.
+ *
+ * This should cause the execution on the CPU to be interrupted and forcing it
+ * to enter kernel context. It is optimized version of a RTMpOnSpecific call
+ * with a worker which returns immediately.
+ *
+ * @returns IPRT status code.
+ * @retval  VERR_NOT_SUPPORTED if this kind of operation isn't supported by the
+ *          system. The caller must not automatically assume that this API works
+ *          when any of the RTMpOn* APIs works. This is because not all systems
+ *          supports unicast MP events and this API will not be implemented as a
+ *          broadcast.
+ * @retval  VERR_CPU_OFFLINE if the CPU is offline.
+ * @retval  VERR_CPU_NOT_FOUND if the CPU wasn't found.
+ *
+ * @param   idCpu           The id of the CPU to poke.
+ */
+RTDECL(int) RTMpPokeCpu(RTCPUID idCpu);
+
 
 /**