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
33 .Nd "configure processor sets"
51 .Op Fl j Ar jailid | Fl p Ar pid | Fl t Ar tid | Fl s Ar setid | Fl x Ar irq
54 .Op Fl j Ar jailid | Fl p Ar pid | Fl t Ar tid | Fl s Ar setid | Fl x Ar irq
58 command can be used to assign processor sets to processes, run commands
59 constrained to a given set or list of processors, and query information
60 about processor binding, sets, and available processors in the system.
63 requires a target to modify or query.
64 The target may be specified as a command, process id, thread id, a
65 cpuset id, an irq or a jail id.
68 the target's set id or mask may be queried.
73 the target's CPU mask or set id may be set.
74 If no target is specified,
77 Not all combinations of operations and targets are supported.
79 you may not set the id of an existing set or query and launch a command
82 There are two sets applicable to each process and one private mask per thread.
83 Every process in the system belongs to a cpuset.
84 By default processes are started in set 1.
85 The mask or id may be queried using
87 Each thread also has a private mask of CPUs it is allowed to run
88 on that must be a subset of the assigned set.
89 And finally, there is a root set, numbered 0, that is immutable.
90 This last set is the list of all possible CPUs in the system and is
94 When running a command it may join a set specified with
96 otherwise a new set is created.
97 In addition, a mask for the command may be specified using
99 When used in conjunction with
101 the mask modifies the supplied or created set rather than the private mask
104 The options are as follows:
105 .Bl -tag -width ".Fl l Ar cpu-list"
107 Create a new cpuset and assign the target process to that set.
109 The requested operation should reference the cpuset available via the
114 to print either a list of valid CPUs or, using
116 the id of the target.
120 option print the id rather than the valid mask of the target.
122 Specifies a jail id as the target of the operation.
124 Specifies a list of CPUs to apply to a target.
125 Specification may include
126 numbers separated by '-' for ranges and commas separating individual numbers.
129 may be specified in which case the list includes all CPUs from the root set.
131 Specifies a pid as the target of the operation.
133 Specifies a set id as the target of the operation.
135 The requested operation should reference the root set available via the
138 Specifies a thread id as the target of the operation.
140 Specifies an irq as the target of the operation.
145 Create a new group with CPUs 0-4 inclusive and run
148 .Dl cpuset -c -l 0-4 /bin/sh
150 Query the mask of CPUs the
152 is allowed to run on:
153 .Dl cpuset -g -p <sh pid>
157 to run on CPUs 0 and 2 while its group is still allowed to run on
159 .Dl cpuset -l 0,2 -p <sh pid>
163 belongs to restricting it to CPUs 0 and 2:
164 .Dl cpuset -l 0,2 -c -p <sh pid>
166 Modify the cpuset all threads are in by default to contain only
167 the first 4 CPUs, leaving the rest idle:
168 .Dl cpuset -l 0-3 -s 1
170 Print the id of the cpuset
173 .Dl cpuset -g -i -p <sh pid>
177 into the specified cpuset
179 so it may be managed with other pids in that set:
180 .Dl cpuset -s <setid> -p <pid>
182 Create a new cpuset that is restricted to CPUs 0 and 2 and move
185 .Dl cpuset -C -c -l 0,2 -p <pid>
191 command first appeared in
194 .An Jeffrey Roberson Aq jeff@FreeBSD.org