Changeset 7325 in vbox

Timestamp:

Mar 6, 2008 3:00:47 PM (17 years ago)

Author:

vboxsync

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

28742

Message:

Added RTMpIsCpuOnline and RTMpDoesCpuExist. (not implemented everywhere)

File:

• trunk/include/iprt/mp.h (modified) (8 diffs)

trunk/include/iprt/mp.h

@@ -38 +38 @@
  */
 
-/** Maximum number of CPUs we support in one system. 
+/** Maximum number of CPUs we support in one system.
  * @remarks The current limit in Windows (affinity mask)
  *
@@ -45 +45 @@
 
 
-/** A CPU identifier. 
- * @remarks This doesn't have to correspond to the APIC ID (intel/amd). Nor 
+/** A CPU identifier.
+ * @remarks This doesn't have to correspond to the APIC ID (intel/amd). Nor
  *          does it have to correspond to the bits in the affinity mask, at
  *          least not until we've sorted out Windows NT. */
@@ -59 +59 @@
 /**
  * Gets the identifier of the CPU executing the call.
- * 
+ *
  * When called from a system mode where scheduling is active, like ring-3 or
  * kernel mode with interrupts enabled on some systems, no assumptions should
  * be made about the current CPU when the call returns.
- * 
+ *
  * @returns CPU Id.
  */
 RTDECL(RTCPUID) RTMpCpuId(void);
+
+/**
+ * Checks if a CPU is online or not.
+ *
+ * @returns true/false accordingly.
+ * @param   idCpu       The identifier of the CPU.
+ */
+RTDECL(bool) RTMpIsCpuOnline(RTCPUID idCpu);
+
+/**
+ * Checks if a CPU exist or not / validates a CPU id.
+ *
+ * @returns true/false accordingly.
+ * @param   idCpu       The identifier of the CPU.
+ */
+RTDECL(bool) RTMpDoesCpuExist(RTCPUID idCpu);
+
+/** @todo we need some kind of RTCPUSET and converstion between RTCPUID and it. */
+
 
 #ifdef IN_RING0
@@ -73 +92 @@
  * Worker function passed to RTMpOnAll, RTMpOnOthers and RTMpOnSpecific that
  * is to be called on the target cpus.
- * 
+ *
  * @param   idCpu       The identifier for the CPU the function is called on.
  * @param   pvUser1     The 1st user argument.
@@ -84 +103 @@
 /**
  * Executes a function on each (online) CPU in the system.
- * 
+ *
  * @returns IPRT status code.
  * @retval  VINF_SUCCESS on success.
  * @retval  VERR_NOT_SUPPORTED if this kind of operation isn't supported by the system.
- * 
+ *
  * @param   pfnWorker       The worker function.
- * @param   pvUser1         The first user argument for the worker.        
- * @param   pvUser2         The second user argument for the worker.        
+ * @param   pvUser1         The first user argument for the worker.
+ * @param   pvUser2         The second user argument for the worker.
  *
  * @remarks The execution isn't in any way guaranteed to be simultaneous,
@@ -100 +119 @@
 /**
  * Executes a function on a all other (online) CPUs in the system.
- * 
+ *
  * @returns IPRT status code.
  * @retval  VINF_SUCCESS on success.
  * @retval  VERR_NOT_SUPPORTED if this kind of operation isn't supported by the system.
- * 
+ *
  * @param   pfnWorker       The worker function.
- * @param   pvUser1         The first user argument for the worker.        
- * @param   pvUser2         The second user argument for the worker.        
- * 
+ * @param   pvUser1         The first user argument for the worker.
+ * @param   pvUser2         The second user argument for the worker.
+ *
  * @remarks The execution isn't in any way guaranteed to be simultaneous,
  *          it might even be serial (cpu by cpu).
@@ -116 +135 @@
 /**
  * Executes a function on a specific CPU in the system.
- * 
+ *
  * @returns IPRT status code.
  * @retval  VINF_SUCCESS on success.
@@ -122 +141 @@
  * @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.
  * @param   pfnWorker       The worker function.
- * @param   pvUser1         The first user argument for the worker.        
- * @param   pvUser2         The second user argument for the worker.        
+ * @param   pvUser1         The first user argument for the worker.
+ * @param   pvUser2         The second user argument for the worker.
  */
 RTDECL(int) RTMpOnSpecific(RTCPUID idCpu, PFNRTMPWORKER pfnWorker, void *pvUser1, void *pvUser2);