usr.bin/cpuset/cpuset.1

   1 .\" Copyright (c) 2008 Christian Brueffer
   2 .\" Copyright (c) 2008 Jeffrey Roberson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   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.
  13 .\"
  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
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd November 29, 2008
  29 .Dt CPUSET 1
  30 .Os
  31 .Sh NAME
  32 .Nm cpuset
  33 .Nd "configure processor sets"
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Fl l Ar cpu-list
  37 .Op Fl s Ar setid
  38 .Ar cmd ...
  39 .Nm
  40 .Op Fl l Ar cpu-list
  41 .Op Fl s Ar setid
  42 .Fl p Ar pid
  43 .Nm
  44 .Op Fl cr
  45 .Op Fl l Ar cpu-list
  46 .Op Fl j Ar jailid | Fl p Ar pid | Fl t Ar tid | Fl s Ar setid | Fl x Ar irq
  47 .Nm
  48 .Op Fl cgir
  49 .Op Fl j Ar jailid | Fl p Ar pid | Fl t Ar tid | Fl s Ar setid | Fl x Ar irq
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 command can be used to assign processor sets to processes, run commands
  54 constrained to a given set or list of processors, and query information
  55 about processor binding, sets, and available processors in the system.
  56 .Pp
  57 .Nm
  58 requires a target to modify or query.
  59 The target may be specified as a command, process id, thread id, a
  60 cpuset id, an irq or a jail id.
  61 Using
  62 .Fl g
  63 the target's set id or mask may be queried.
  64 Using
  65 .Fl l
  66 or
  67 .Fl s
  68 the target's CPU mask or set id may be set.
  69 If no target is specified,
  70 .Nm
  71 operates on itself.
  72 Not all combinations of operations and targets are supported.
  73 For example,
  74 you may not set the id of an existing set or query and launch a command
  75 at the same time.
  76 .Pp
  77 There are two sets applicable to each process and one private mask per thread.
  78 Every process in the system belongs to a cpuset.
  79 By default processes are started in set 1.
  80 The mask or id may be queried using
  81 .Fl c .
  82 Each thread also has a private mask of CPUs it is allowed to run
  83 on that must be a subset of the assigned set.
  84 And finally, there is a root set, numbered 0, that is immutable.
  85 This last set is the list of all possible CPUs in the system and is
  86 queried using
  87 .Fl r .
  88 .Pp
  89 When running a command it may join a set specified with
  90 .Fl s
  91 otherwise a new set is created.
  92 In addition, a mask for the command may be specified using
  93 .Fl l .
  94 When used in conjunction with
  95 .Fl c
  96 the mask modifies the supplied or created set rather than the private mask
  97 for the thread.
  98 .Pp
  99 The options are as follows:
 100 .Bl -tag -width ".Fl l Ar cpu-list"
 101 .It Fl c
 102 The requested operation should reference the cpuset available via the
 103 target specifier.
 104 .It Fl g
 105 Causes
 106 .Nm
 107 to print either a list of valid CPUs or, using
 108 .Fl i ,
 109 the id of the target.
 110 .It Fl i
 111 When used with the
 112 .Fl g
 113 option print the id rather than the valid mask of the target.
 114 .It Fl j Ar jailid
 115 Specifies a jail id as the target of the operation.
 116 .It Fl l Ar cpu-list
 117 Specifies a list of CPUs to apply to a target.
 118 Specification may include
 119 numbers separated by '-' for ranges and commas separating individual numbers.
 120 .It Fl p Ar pid
 121 Specifies a pid as the target of the operation.
 122 .It Fl s Ar setid
 123 Specifies a set id as the target of the operation.
 124 .It Fl r
 125 The requested operation should reference the root set available via the
 126 target specifier.
 127 .It Fl t Ar tid
 128 Specifies a thread id as the target of the operation.
 129 .It Fl x Ar irq
 130 Specifies an irq as the target of the operation.
 131 .El
 132 .Sh EXIT STATUS
 133 .Ex -std
 134 .Sh EXAMPLES
 135 Create a new group with CPUs 0-4 inclusive and run
 136 .Pa /bin/sh
 137 on it:
 138 .Dl cpuset -c -l 0-4 /bin/sh
 139 .Pp
 140 Query the mask of CPUs the
 141 .Aq sh pid
 142 is allowed to run on:
 143 .Dl cpuset -g -p <sh pid>
 144 .Pp
 145 Restrict
 146 .Pa /bin/sh
 147 to run on CPUs 0 and 2 while its group is still allowed to run on
 148 CPUs 0-4:
 149 .Dl cpuset -l 0,2 -p <sh pid>
 150 .Pp
 151 Modify the cpuset
 152 .Pa /bin/sh
 153 belongs to restricting it to CPUs 0 and 2:
 154 .Dl cpuset -l 0,2 -c -p <sh pid>
 155 .Pp
 156 Modify the cpuset all threads are in by default to contain only
 157 the first 4 CPUs, leaving the rest idle:
 158 .Dl cpuset -l 0-3 -s 1
 159 .Pp
 160 Print the id of the cpuset
 161 .Pa /bin/sh
 162 is in:
 163 .Dl cpuset -g -i -p <sh pid>
 164 .Pp
 165 Move the
 166 .Ar pid
 167 into the specified cpuset
 168 .Ar setid
 169 so it may be managed with other pids in that set:
 170 .Dl cpuset -s <setid> -p <pid>
 171 .Sh SEE ALSO
 172 .Xr cpuset 2
 173 .Sh HISTORY
 174 The
 175 .Nm
 176 command first appeared in
 177 .Fx 7.1 .
 178 .Sh AUTHORS
 179 .An Jeffrey Roberson Aq jeff@FreeBSD.org