osaCPUAffinity.h File Reference

Functions for multi-core CPUs. More...

#include <cisstOSAbstraction/osaExport.h>

Go to the source code of this file.

Typedefs
typedef unsigned short	osaCPUMask

Enumerations
enum	osaErrno { OSAFAILURE =-1 , OSASUCCESS =0 }

Functions
CISST_EXPORT int	osaCPUGetCount ()
	Return the number of available CPUs.
CISST_EXPORT osaErrno	osaCPUSetAffinity (osaCPUMask mask)
	Set the affinity of the current thread.

Variables
const osaCPUMask	OSA_CPUANY = 0x0000
const osaCPUMask	OSA_CPU1 = 0x0001
const osaCPUMask	OSA_CPU2 = 0x0002
const osaCPUMask	OSA_CPU3 = 0x0004
const osaCPUMask	OSA_CPU4 = 0x0008
const osaCPUMask	OSA_CPU5 = 0x0010
const osaCPUMask	OSA_CPU6 = 0x0020
const osaCPUMask	OSA_CPU7 = 0x0040
const osaCPUMask	OSA_CPU8 = 0x0080
const osaCPUMask	OSA_CPU9 = 0x0100
const osaCPUMask	OSA_CPU10 = 0x0200
const osaCPUMask	OSA_CPU11 = 0x0400
const osaCPUMask	OSA_CPU12 = 0x0800
const osaCPUMask	OSA_CPU13 = 0x1000
const osaCPUMask	OSA_CPU14 = 0x2000
const osaCPUMask	OSA_CPU15 = 0x4000
const osaCPUMask	OSA_CPU16 = 0x8000
const osaCPUMask	OSA_CPU_LAST = OSA_CPU16

Detailed Description

Functions for multi-core CPUs.

Typedef Documentation

osaCPUMask

typedef unsigned short osaCPUMask

Enumeration Type Documentation

osaErrno

enum osaErrno

Enumerator
OSAFAILURE
OSASUCCESS

Function Documentation

osaCPUGetCount()

CISST_EXPORT int osaCPUGetCount

(

)

Return the number of available CPUs.

On SMP architectures, return the number of available CPUs.

Returns

The number of available CPUs.

osaCPUSetAffinity()

CISST_EXPORT osaErrno osaCPUSetAffinity

(

osaCPUMask

mask

)

Set the affinity of the current thread.

On SMP architectures, sets the affinity of the current thread to one or several CPU. The mask can represent more than one CPU in which case the OS will decide which CPU of a set to run the thread.

Parameters

mask	A bitfield mask of CPUs.

Returns

OSASUCCESS if the operation succeeded. OSAERROR otherwise.

Variable Documentation

OSA_CPU1

const osaCPUMask OSA_CPU1 = 0x0001

OSA_CPU10

const osaCPUMask OSA_CPU10 = 0x0200

OSA_CPU11

const osaCPUMask OSA_CPU11 = 0x0400

OSA_CPU12

const osaCPUMask OSA_CPU12 = 0x0800

OSA_CPU13

const osaCPUMask OSA_CPU13 = 0x1000

OSA_CPU14

const osaCPUMask OSA_CPU14 = 0x2000

OSA_CPU15

const osaCPUMask OSA_CPU15 = 0x4000

OSA_CPU16

const osaCPUMask OSA_CPU16 = 0x8000

OSA_CPU2

const osaCPUMask OSA_CPU2 = 0x0002

OSA_CPU3

const osaCPUMask OSA_CPU3 = 0x0004

OSA_CPU4

const osaCPUMask OSA_CPU4 = 0x0008

OSA_CPU5

const osaCPUMask OSA_CPU5 = 0x0010

OSA_CPU6

const osaCPUMask OSA_CPU6 = 0x0020

OSA_CPU7

const osaCPUMask OSA_CPU7 = 0x0040

OSA_CPU8

const osaCPUMask OSA_CPU8 = 0x0080

OSA_CPU9

const osaCPUMask OSA_CPU9 = 0x0100

OSA_CPU_LAST

const osaCPUMask OSA_CPU_LAST = OSA_CPU16

OSA_CPUANY

const osaCPUMask OSA_CPUANY = 0x0000