usr.sbin/psrset/psrset.8

   1 .\"     $NetBSD: psrset.8,v 1.4 2008/06/23 06:52:43 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2008 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   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 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd September 23, 2008
  28 .Dt PSRSET 8
  29 .Os
  30 .Sh NAME
  31 .Nm psrset
  32 .Nd control processor sets
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Ar setid ...
  36 .Nm
  37 .Fl a Ar setid Ar cpuid Ar ...
  38 .Nm
  39 .Fl b Ar setid Ar pid Ar ...
  40 .Nm
  41 .Fl c Op Ar cpuid Ar ...
  42 .Nm
  43 .Fl d Ar setid
  44 .Nm
  45 .Fl e Ar setid Ar command
  46 .Nm
  47 .Fl i Op Ar setid ...
  48 .Nm
  49 .Fl p
  50 .Nm
  51 .Fl r Ar cpuid Ar ...
  52 .Nm
  53 .Fl u Ar pid Ar ...
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 command can be used to control and inspect processor sets.
  58 .Pp
  59 The system always contains at least one processor set: the default
  60 set.
  61 The default set must contain at least one online processor (CPU) at
  62 all times.
  63 .Pp
  64 Available options:
  65 .Bl -tag -width indent
  66 .It Fl a
  67 Assign one or more processors (CPUs) to the set
  68 .Ar setid .
  69 In the current implementation, a CPU may only be present in one set.
  70 CPU IDs are as reported and used by the
  71 .Xr cpuctl 8
  72 command.
  73 .It Fl b
  74 Bind one or more processes to the set
  75 .Ar setid .
  76 All LWPs within the processes will be affected.
  77 Bindings are inherited when new LWPs or processes are forked.
  78 However, setting a new binding on a parent process does not affect the
  79 bindings of its existing child processes.
  80 .It Fl c
  81 Create a new processor set.
  82 If successful, the ID of the new set will be printed.
  83 If a list of CPU IDs is provided, those CPUs will be assigned to the set
  84 upon creation.
  85 Otherwise, the set will be created empty.
  86 .It Fl d
  87 Delete the processor set specified by
  88 .Ar setid .
  89 Any LWPs bound to the set will be re-bound to the default processor set.
  90 .It Fl e
  91 Execute a command within the processor set specified by
  92 .Ar setid .
  93 .It Fl i
  94 List all processor sets.
  95 For each set, print the member CPUs.
  96 If
  97 .Nm
  98 is run without any options, it behaves as if
  99 .Fl i
 100 were given.
 101 .It Fl p
 102 List all CPUs.
 103 For each CPU, print the associated processor set.
 104 .It Fl r
 105 Remove a CPU from its current set, and return it back to the default
 106 processor set.
 107 .It Fl u
 108 Bind the specified processes to the system default processor set.
 109 .El
 110 .Sh SEE ALSO
 111 .Xr pset 3 ,
 112 .Xr cpuctl 8 ,
 113 .Xr schedctl 8
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 command first appeared in
 118 .Nx 5.0 .