2 .\" Copyright (c) 2010 Xin LI <delphij@FreeBSD.org>
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .Dt PTHREAD_ATTR_AFFINITY_NP 3
31 .Nm pthread_attr_getaffinity_np ,
32 .Nm pthread_attr_setaffinity_np
33 .Nd manage CPU affinity in thread attribute objects
39 .Fn pthread_attr_getaffinity_np "const pthread_attr_t *pattr" "size_t cpusetsize" "cpuset_t *cpusetp"
41 .Fn pthread_attr_setaffinity_np "pthread_attr_t *pattr" "size_t cpusetsize" "const cpuset_t *cpusetp"
44 .Fn pthread_attr_getaffinity_np
46 .Fn pthread_attr_setaffinity_np
47 functions allow the manipulation of sets of CPUs available to the specified thread attribute object.
51 are composed using the
54 If the user-supplied mask is not large enough to fit all of the matching CPUs,
55 .Fn pthread_attr_getaffinity_np
59 .Fn pthread_attr_setaffinity_np
60 tolerate masks of any size with no restrictions.
61 .Fn pthread_attr_setaffinity_np
62 uses the meaningful part of the mask, where the upper bound is
63 the maximum CPU id present in the system.
64 If bits for non-existing CPUs are set, calls to
65 .Fn pthread_attr_setaffinity_np
69 The supplied mask should have a size of
72 This size is usually provided by calling
74 which is ultimately determined by the value of
79 .Fn pthread_attr_getaffinity_np
81 mask from the thread attribute object specified by
83 and stores it in the space provided by
86 .Fn pthread_attr_setaffinity_np
87 sets the mask for the thread attribute object specified by
93 .Fn pthread_attr_getaffinity_np
95 .Fn pthread_attr_setaffinity_np
96 functions will return zero.
97 Otherwise an error number will be returned
98 to indicate the error.
101 .Fn pthread_attr_getaffinity_np
102 functions will fail if:
107 or the attribute specified by it is
116 .Fn pthread_attr_setaffinity_np
117 function will fail if:
122 or the attribute specified by it is
127 specified a CPU that was outside the set supported by the kernel.
129 Insufficient memory exists to store the cpuset mask.
136 .Xr pthread_getaffinity_np 3 ,
138 .Xr pthread_setaffinity_np 3
141 .Nm pthread_attr_getaffinity_np
143 .Nm pthread_attr_setaffinity_np
144 functions are non-standard
146 extensions and may be not available on other operating systems.
149 .Nm pthread_attr_getaffinity_np
151 .Nm pthread_attr_setaffinity_np
152 functions first appeared in
157 .Nm pthread_attr_getaffinity_np
159 .Nm pthread_attr_setaffinity_np
160 functions were written by
161 .An David Xu Aq Mt davidxu@FreeBSD.org ,
162 and this manpage was written by
163 .An Xin LI Aq Mt delphij@FreeBSD.org .