cpuset.h revision 7a21f97c0af14dfd4b7d825737b2571b45a2e18d
5b281ba489ca18f0380d7efc7a5108b606cce449vboxsync * IPRT - CPU Set.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Copyright (C) 2008 Sun Microsystems, Inc.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * available from http://www.virtualbox.org. This file is free software;
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * you can redistribute it and/or modify it under the terms of the GNU
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * General Public License (GPL) as published by the Free Software
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * The contents of this file may alternatively be used under the terms
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * of the Common Development and Distribution License Version 1.0
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * VirtualBox OSE distribution, in which case the provisions of the
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * CDDL are applicable instead of those of the GPL.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * You may elect to license modified versions of this file under the
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * terms and conditions of either the GPL or the CDDL or both.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * additional information or have any questions.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync/** @defgroup grp_rt_mp RTCpuSet - CPU Set
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @ingroup grp_rt
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync * The maximum number of CPUs a set can contain and IPRT is able
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync * to reference.
5e5603ae40c7a0a884fe91e269b7d6d6c0ba56f5vboxsync * @remarks This is the maximum value of the supported platforms.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * Clear all CPUs.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync * @returns pSet.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * Set all CPUs.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync * @returns pSet.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * Adds a CPU given by its identifier to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @returns 0 on success, -1 if idCpu isn't valid.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param idCpu The identifier of the CPU to add.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @remarks The modification is atomic.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsyncDECLINLINE(int) RTCpuSetAdd(PRTCPUSET pSet, RTCPUID idCpu)
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * Removes a CPU given by its identifier from the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @returns 0 on success, -1 if idCpu isn't valid.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param idCpu The identifier of the CPU to delete.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @remarks The modification is atomic.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsyncDECLINLINE(int) RTCpuSetDel(PRTCPUSET pSet, RTCPUID idCpu)
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * Checks if a CPU given by its identifier is a member of the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @returns true / false accordingly.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param idCpu The identifier of the CPU to look for.
0aaf889969ebdaba8a310db13adcec8c10174796vboxsync * @remarks The test is atomic.
8e4e0ad3b6c8d4f700608694f39fd724d64279e9vboxsyncDECLINLINE(bool) RTCpuSetIsMember(PCRTCPUSET pSet, RTCPUID idCpu)
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync return false;
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * Checks if a CPU given by its index is a member of the set.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * @returns true / false accordingly.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * @param pSet Pointer to the set.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * @param iCpu The index of the CPU in the set.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync * @remarks The test is atomic.
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsyncDECLINLINE(bool) RTCpuSetIsMemberByIndex(PCRTCPUSET pSet, RTCPUID iCpu)
7a21f97c0af14dfd4b7d825737b2571b45a2e18dvboxsync return false;
67c73271505adae0686ddbc74eaeef778ef16792vboxsync * Checks if the two sets match or not.
67c73271505adae0686ddbc74eaeef778ef16792vboxsync * @returns true / false accordingly.
67c73271505adae0686ddbc74eaeef778ef16792vboxsync * @param pSet1 The first set.
67c73271505adae0686ddbc74eaeef778ef16792vboxsync * @param pSet2 The second set.
67c73271505adae0686ddbc74eaeef778ef16792vboxsyncDECLINLINE(bool) RTCpuSetIsEqual(PCRTCPUSET pSet1, PCRTCPUSET pSet2)
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * Converts the CPU set to a 64-bit mask.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @returns The mask.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * Initializes the CPU set from a 64-bit mask.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param pSet Pointer to the set.
5c1381fc884d30a749517579368ff6cb4b43e809vboxsync * @param fMask The mask.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsyncDECLINLINE(PRTCPUSET) RTCpuSetFromU64(PRTCPUSET pSet, uint64_t fMask)
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync * Count the CPUs in the set.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync * @returns CPU count.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync * @param pSet Pointer to the set.
d23a94a28e59f64d02905f20bb8f3b23f1c9eb17vboxsync while (iCpu-- > 0)