lib/libc/sys/sched_setaffinity.2

   1 .\" Copyright (c) 2017 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Sepherosa Ziehau <sepherosa@gmail.com>.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .Dd January 14, 2017
  34 .Dt SCHED_SETAFFINITY 2
  35 .Os
  36 .Sh NAME
  37 .Nm CPU_AND ,
  38 .Nm CPU_CLR ,
  39 .Nm CPU_COUNT ,
  40 .Nm CPU_EQUAL ,
  41 .Nm CPU_ISSET ,
  42 .Nm CPU_OR ,
  43 .Nm CPU_SET ,
  44 .Nm CPU_XOR ,
  45 .Nm CPU_ZERO ,
  46 .Nm sched_setaffinity ,
  47 .Nm sched_getaffinity
  48 .Nd set and get a process's CPU affinity mask
  49 .Sh LIBRARY
  50 .Lb libc
  51 .Sh SYNOPSIS
  52 .In sys/types.h
  53 .In sys/sched.h
  54 .Ft int
  55 .Fn sched_setaffinity "pid_t pid" "size_t cpusetsize" "const cpu_set_t *mask"
  56 .Ft int
  57 .Fn sched_getaffinity "pid_t pid" "size_t cpusetsize" "cpu_set_t *mask"
  58 .Fn CPU_ZERO &mask
  59 .Fn CPU_SET cpu &mask
  60 .Fn CPU_CLR cpu &mask
  61 .Fn CPU_ISSET cpu &mask
  62 .Fn CPU_COUNT &mask
  63 .Fn CPU_AND &dstmask &srcmask1 &srcmask2
  64 .Fn CPU_OR &dstmask &srcmask1 srcmask2
  65 .Fn CPU_XOR &dstmask &srcmask1 &srcmask2
  66 .Fn CPU_EQUAL &mask1 &mask2
  67 .Sh DESCRIPTION
  68 The
  69 .Fn sched_setaffinity
  70 sets the CPU affinity mask of the process,
  71 which is identified by the
  72 .Fa pid
  73 to the value specified by the
  74 .Fa mask .
  75 The
  76 .Fa cpusetsize
  77 is the length (in bytes) of the data pointed to by
  78 .Fa mask .
  79 Normally this argument would be specified as sizeof(cpu_set_t).
  80 If the
  81 .Fa pid
  82 is zero,
  83 then the pid of the calling process is used.
  84 All threads of the process identified by
  85 .Fa pid
  86 are affected.
  87 If the calling thread is one of the target process's threads,
  88 then the calling thread will be migrated immediately,
  89 if necessary,
  90 while other threads of the targt process will be migrated
  91 by the scheduler later.
  92 .Pp
  93 A process created by
  94 .Xr fork 2 ,
  95 .Xr vfork 2 ,
  96 and
  97 .Xr rfork 2
  98 inherits the calling thread's CPU affinity mask.
  99 Same applies to the threads created by
 100 .Xr lwp_create 2 ,
 101 and the threads created by
 102 .Xr pthread_create 3 .
 103 .Pp
 104 .Fn sched_getaffinity
 105 writes the affinity mask of the process
 106 identified by the
 107 .Fa pid
 108 to the cpu_set_t structure pointed to by
 109 .Fa mask .
 110 If the
 111 .Fa pid
 112 is zero,
 113 then the pid of the calling process is used.
 114 If the process is multithreaded,
 115 then the CPU affinity mask of the first thread will be returned.
 116 .Pp
 117 The cpu_set_t data structure represents a set of CPUs.
 118 The first available CPU on the system corresponds to a cpu value of 0,
 119 the next CPU corresponds to a cpu value of 1,
 120 and so on and so forth.
 121 The constant
 122 .Dv CPU_SETSIZE
 123 specifies a value one greater than the maximum
 124 CPU number that can be stored in cpu_set_t.
 125 The cpu_set_t should be treated as opaque data structure;
 126 all manipulation of cpu_set_t should be done via the following macros:
 127 .Bl -tag -width "CPU_COUNTxxx"
 128 .It Fn CPU_ZERO
 129 Reset the
 130 .Fa mask ,
 131 so that it contains no CPUs.
 132 .It Fn CPU_SET
 133 Add the
 134 .Fa cpu
 135 to the
 136 .Fa mask .
 137 .It Fn CPU_CLR
 138 Remove the
 139 .Fa cpu
 140 from the
 141 .Fa mask .
 142 .It Fn CPU_ISSET
 143 Test to see whether the
 144 .Fa cpu
 145 is a member of the
 146 .Fa mask .
 147 .It Fn CPU_COUNT
 148 Return the number of CPUs in the
 149 .Fa mask .
 150 .It Fn CPU_AND
 151 Store the intersection of the
 152 .Fa srcmask1
 153 and the
 154 .Fa srcmask2
 155 in the
 156 .Fa dstmask .
 157 The
 158 .Fa dstmask
 159 could be one of the source masks.
 160 .It Fn CPU_OR
 161 Store the union of the
 162 .Fa srcmask1
 163 and the
 164 .Fa srcmask2
 165 in the
 166 .Fa dstmask .
 167 The
 168 .Fa dstmask
 169 could be one of the source masks.
 170 .It Fn CPU_XOR
 171 Store the XOR of the
 172 .Fa srcmask1
 173 and the
 174 .Fa srcmask2
 175 in the
 176 .Fa dstmask .
 177 The
 178 .Fa dstmask
 179 could be one of the source masks.
 180 .It Fn CPU_EQUAL
 181 Test whether the
 182 .Fa mask1
 183 and the
 184 .Fa mask2
 185 contain the same CPUs.
 186 .El
 187 .Sh RETURN VALUES
 188 These system calls return \-1 on error and
 189 0 upon successful completion.
 190 .Sh ERRORS
 191 The
 192 .Fn sched_setaffinity
 193 and
 194 .Fn sched_getaffinity
 195 will fail if:
 196 .Bl -tag -width Er
 197 .It Bq Er EFAULT
 198 The
 199 .Fa mask
 200 parameter is outside the process's allocated address space.
 201 .It Bq Er EINVAL
 202 The
 203 .Fa pid
 204 parameter is negative.
 205 .It Bq Er ESRCH
 206 The process identified by the
 207 .Fa pid
 208 does not exist.
 209 .It Bq Er EPERM
 210 The
 211 .Fa mask
 212 does not contain a valid CPU.
 213 .El
 214 .Sh SEE ALSO
 215 .Xr fork 2 ,
 216 .Xr lwp_create 2 ,
 217 .Xr lwp_getaffinity 2 ,
 218 .Xr lwp_setaffinity 2 ,
 219 .Xr rfork 2 ,
 220 .Xr vfork 2 ,
 221 .Xr pthread_create 3 ,
 222 .Xr pthread_getaffinity_np 3 ,
 223 .Xr pthread_setaffinity_np 3
 224 .Sh HISTORY
 225 The
 226 .Fn sched_setaffinity
 227 and
 228 .Fn sched_getaffinity
 229 functions first appeared in
 230 .Dx 4.7 .