cpuset.h revision 5b281ba489ca18f0380d7efc7a5108b606cce449
/** @file
* IPRT - CPU Set.
*/
/*
* Copyright (C) 2008 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
#ifndef ___iprt_cpuset_h
#define ___iprt_cpuset_h
#include <iprt/types.h>
#include <iprt/mp.h> /* RTMpCpuIdToSetIndex */
__BEGIN_DECLS
/** @defgroup grp_rt_mp RTCpuSet - CPU Set
* @ingroup grp_rt
* @{
*/
/**
* The maximum number of CPUs a set can contain and IPRT is able
* to reference.
* @remarks This is the maximum value of the supported platforms.
*/
#define RTCPUSET_MAX_CPUS 64
/**
* Clear all CPUs.
*
* @returns pSet.
* @param pSet Pointer to the set.
*/
DECLINLINE(PRTCPUSET) RTCpuSetEmpty(PRTCPUSET pSet)
{
*pSet = 0;
return pSet;
}
/**
* Set all CPUs.
*
* @returns pSet.
* @param pSet Pointer to the set.
*/
DECLINLINE(PRTCPUSET) RTCpuSetFill(PRTCPUSET pSet)
{
*pSet = UINT64_MAX;
return pSet;
}
/**
* Adds a CPU given by it's identifier to the set.
*
* @returns 0 on success, -1 if idCpu isn't valid.
* @param pSet Pointer to the set.
* @param idCpu The identifier of the CPU to add.
*/
DECLINLINE(int) RTCpuSetAdd(PRTCPUSET pSet, RTCPUID idCpu)
{
int iCpu = RTMpCpuIdToSetIndex(idCpu);
if (RT_UNLIKELY(iCpu < 0))
return -1;
*pSet |= RT_BIT_64(iCpu);
return 0;
}
/**
* Removes a CPU given by it's identifier from the set.
*
* @returns 0 on success, -1 if idCpu isn't valid.
* @param pSet Pointer to the set.
* @param idCpu The identifier of the CPU to delete.
*/
DECLINLINE(int) RTCpuSetDel(PRTCPUSET pSet, RTCPUID idCpu)
{
int iCpu = RTMpCpuIdToSetIndex(idCpu);
if (RT_UNLIKELY(iCpu < 0))
return -1;
*pSet &= ~RT_BIT_64(iCpu);
return 0;
}
/**
* Checks if a CPU given by it's identifier is a member of the set.
*
* @returns true / false accordingly.
* @param pSet Pointer to the set.
* @param idCpu The identifier of the CPU to look for.
*/
DECLINLINE(bool) RTCpuSetIsMember(PCRTCPUSET pSet, RTCPUID idCpu)
{
int iCpu = RTMpCpuIdToSetIndex(idCpu);
if (RT_UNLIKELY(iCpu < 0))
return false;
return !!(*pSet & RT_BIT_64(iCpu));
}
/**
* Converts the CPU set to a 64-bit mask.
*
* @returns The mask.
* @param pSet Pointer to the set.
*/
DECLINLINE(uint64_t) RTCpuSetToU64(PCRTCPUSET pSet)
{
return *pSet;
}
/**
* Initializes the CPU set from a 64-bit mask.
*
* @param pSet Pointer to the set.
* @param fMask The mask.
*/
DECLINLINE(PRTCPUSET) RTCpuSetFromU64(PRTCPUSET pSet, uint64_t fMask)
{
*pSet = fMask;
return pSet;
}
/**
* Count the CPUs in the set.
*
* @returns CPU count.
* @param pSet Pointer to the set.
*/
DECLINLINE(RTCPUID) RTCpuSetCount(PRTCPUSET pSet)
{
RTCPUID cCpus = 0;
RTCPUID iCpu = 64;
while (iCpu-- > 0)
if (*pSet & RT_BIT_64(iCpu))
cCpus++;
return cCpus;
}
/** @} */
__END_DECLS
#endif