cpu_set(3) - Linux man page

From: http://linux.die.net/man/3/cpu_set

 

Name

CPU_SET, CPU_CLR, CPU_ISSET, CPU_ZERO, CPU_COUNT, CPU_AND, CPU_OR, CPU_XOR, CPU_EQUAL, CPU_ALLOC, CPU_ALLOC_SIZE, CPU_FREE, CPU_SET_S, CPU_CLR_S, CPU_ISSET_S, CPU_ZERO_S, CPU_COUNT_S, CPU_AND_S, CPU_OR_S, CPU_XOR_S, CPU_EQUAL_S - macros for manipulating CPU sets

 

Synopsis

#define _GNU_SOURCE             /* See feature_test_macros(7) */#include
<sched.h>
void CPU_ZERO(cpu_set_t *set);
void CPU_SET(int cpu, cpu_set_t *set);void CPU_CLR(int cpu, cpu_set_t *set);int
 CPU_ISSET(int cpu, cpu_set_t *set);
int  CPU_COUNT(cpu_set_t *set);
void CPU_AND(cpu_set_t *destset,             cpu_set_t *srcset1, cpu_set_t
*srcset2);void CPU_OR(cpu_set_t *destset,             cpu_set_t *srcset1,
cpu_set_t *srcset2);void CPU_XOR(cpu_set_t *destset,             cpu_set_t
*srcset1, cpu_set_t *srcset2);
int  CPU_EQUAL(cpu_set_t *set1, cpu_set_t *set2);
cpu_set_t *CPU_ALLOC(int num_cpus);void CPU_FREE(cpu_set_t *set);size_t
CPU_ALLOC_SIZE(int num_cpus);
void CPU_ZERO_S(size_t setsize, cpu_set_t *set);
void CPU_SET_S(int cpu, size_t setsize, cpu_set_t *set);void CPU_CLR_S(int
cpu, size_t setsize, cpu_set_t *set);int  CPU_ISSET_S(int cpu, size_t setsize,
cpu_set_t *set);
int  CPU_COUNT_S(size_t setsize, cpu_set_t *set);
void CPU_AND_S(size_t setsize, cpu_set_t *destset,             cpu_set_t
*srcset1, cpu_set_t *srcset2);void CPU_OR_S(size_t setsize, cpu_set_t *destset,
            cpu_set_t *srcset1, cpu_set_t *srcset2);void CPU_XOR_S(size_t
setsize, cpu_set_t *destset,             cpu_set_t *srcset1, cpu_set_t
*srcset2);
int  CPU_EQUAL_S(size_t setsize, cpu_set_t *set1", cpu_set_t *" set2 );

Description

The cpu_set_t data structure represents a set of CPUs. CPU sets are used by sched_setaffinity(2) and similar interfaces.

The cpu_set_t data type is implemented as a bitset. However, the data structure treated as considered opaque: all manipulation of CPU sets should bedone via the macros described in this page.

The following macros are provided to operate on the CPU set set:

CPU_ZERO()

Clears set, so that it contains no CPUs.

CPU_SET()

Add CPU cpu to set.

CPU_CLR()

Remove CPU cpu from set.

CPU_ISSET()

Test to see if CPU cpu is a member of set.

CPU_COUNT()

Return the number of CPUs in set.

Where a cpu argument is specified, it should not produce side effects, since the above macros may evaluate the argument more than once.

The first available CPU on the system corresponds to a cpu value of 0, the next CPU corresponds to a cpu value of 1, and so on. The constantCPU_SETSIZE (currently 1024) specifies a value one greater than the maximum CPU number that can be stored in cpu_set_t.

The following macros perform logical operations on CPU sets:

CPU_AND()

Store the intersection of the sets srcset1 and srcset2 in destset (which may be one of the source sets).

CPU_OR()

Store the union of the sets srcset1 and srcset2 in destset (which may be one of the source sets).

CPU_XOR()

Store the XOR of the sets srcset1 and srcset2 in destset (which may be one of the source sets). The XOR means the set of CPUs that arein either srcset1 or srcset2, but not both.

CPU_EQUAL()

Test whether two CPU set contain exactly the same CPUs.

Dynamically sized CPU sets

Because some applications may require the ability to dynamically size CPU sets (e.g., to allocate sets larger than that defined by the standardcpu_set_t data type), glibc nowadays provides a set of macros to support this.

The following macros are used to allocate and deallocate CPU sets:

CPU_ALLOC()

Allocate a CPU set large enough to hold CPUs in the range 0 to num_cpus-1.

CPU_ALLOC_SIZE()

Return the size in bytes of the CPU set that would be needed to hold CPUs in the range 0 to num_cpus-1. This macro provides the value that can be used for the setsize argument in the CPU_*_S() macros described below.

CPU_FREE()

Free a CPU set previously allocated by CPU_ALLOC().

The macros whose names end with "_S" are the analogs of the similarly named macros without the suffix. These macros perform the same tasks as their analogs, but operate on the dynamically allocated CPUset(s) whose size issetsize bytes.

Return Value

CPU_ISSET() and CPU_ISSET_S() return nonzero ifcpu is inset; otherwise, it returns 0.

CPU_COUNT() and CPU_COUNT_S() return the number of CPUs inset.

CPU_EQUAL() and CPU_EQUAL_S() return nonzero if the two CPU sets are equal; otherwise it returns 0.

CPU_ALLOC() returns a pointer on success, or NULL on failure. (Errors are as formalloc(3).)

CPU_ALLOC_SIZE() returns the number of bytes required to store a CPU set of the specified cardinality.

The other functions do not return a value.