1 .\" Copyright (c) 2008 Christian Brueffer
2 .\" Copyright (c) 2008 Jeffrey Roberson
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .Dt CPUSET_GETAFFINITY 2
32 .Nm cpuset_getaffinity ,
33 .Nm cpuset_setaffinity
34 .Nd manage CPU affinity
41 .Fn cpuset_getaffinity "cpulevel_t level" "cpuwhich_t which" "id_t id" "size_t setsize" "cpuset_t *mask"
43 .Fn cpuset_setaffinity "cpulevel_t level" "cpuwhich_t which" "id_t id" "size_t setsize" "const cpuset_t *mask"
45 .Fn cpuset_getaffinity
47 .Fn cpuset_setaffinity
48 allow the manipulation of sets of CPUs available to processes, threads,
49 interrupts, jails and other resources.
50 These functions may manipulate sets of CPUs that contain many processes
51 or per-object anonymous masks that effect only a single object.
53 The valid values for the
57 arguments are documented in
59 These arguments specify which object and which set of the object we are
61 Not all possible combinations are valid.
62 For example, only processes may belong to a numbered set accessed by a
65 .Dv CPU_LEVEL_CPUSET .
66 All resources, however, have a mask which may be manipulated with
71 are composed using the
74 If the user-supplied mask is not large enough to fit all of the matching CPUs,
75 .Fn cpuset_getaffinity
79 .Fn cpuset_setaffinity
80 tolerate masks of any size with no restrictions.
81 The kernel uses the meaningful part of the mask, where the upper bound is
82 the maximum CPU id present in the system.
83 If bits for non-existing CPUs are set, calls to
84 .Fn cpuset_setaffinity
88 The supplied mask should have a size of
91 This size is usually provided by calling
93 which is ultimately determined by the value of
98 .Fn cpuset_getaffinity
100 mask from the object specified by
105 and stores it in the space provided by
108 .Fn cpuset_setaffinity
109 attempts to set the mask for the object specified by
119 The following error codes may be set in
122 .\" When changing this list, consider updating share/man/man3/pthread_create.3,
123 .\" since that function can return any of these errors.
129 argument was not a valid value.
133 argument specified when calling
134 .Fn cpuset_setaffinity
135 was not a valid value.
138 .Fn cpuset_setaffinity
139 call would leave a thread without a valid CPU to run on because the set
140 does not overlap with the thread's anonymous mask.
142 The mask pointer passed was invalid.
144 The object specified by the
148 arguments could not be found.
152 was smaller than needed to fit all of the matching CPUs.
154 The calling process did not have the credentials required to complete the
157 The calling process attempted to act on a process other than itself, while
165 .Xr cpuset_getdomain 2 ,
167 .Xr cpuset_setdomain 2 ,
169 .Xr pthread_affinity_np 3 ,
170 .Xr pthread_attr_affinity_np 3 ,
176 family of system calls first appeared in
179 .An Jeffrey Roberson Aq Mt jeff@FreeBSD.org