xref: /netbsd-src/usr.sbin/cpuctl/cpuctl.8 (revision 8ac07aec990b9d2e483062509d0a9fa5b4f57cf2)
1.\"	$NetBSD: cpuctl.8,v 1.2 2008/03/25 15:06:02 martin Exp $
2.\"
3.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Andrew Doran.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd August 3, 2007
38.Dt CPUCTL 8
39.Os
40.Sh NAME
41.Nm cpuctl
42.Nd a program to control CPUs
43.Sh SYNOPSIS
44.Nm cpuctl
45.Ar command
46.Op Ar arguments
47.Sh DESCRIPTION
48The
49.Nm
50command can be used to control and inspect the state of CPUs in the system.
51.Pp
52The first argument,
53.Ar command ,
54specifies the action to take.
55Valid commands are:
56.Bl -tag -width xx
57.It list
58.Pp
59For each CPU in the system, display the current state and time of the last
60state change.
61.It offline Ar cpuno
62.Pp
63Set the specified CPU off line.
64.Pp
65Unbound LWPs (lightweight processes) will not be executed on the CPU
66while it is off line.
67Bound LWPs will continue to be executed on the CPU, and device interrupts
68routed to the CPU will continue to be handled.
69A future release of the system may allow device interrupts to be re-routed
70away from individual CPUs.
71.Pp
72At least one CPU in the system must remain on line.
73.It online Ar cpuno
74.Pp
75Set the specified CPU on line, making it available to run unbound LWPs.
76.El
77.Pp
78.Sh FILES
79.Bl -tag -width /dev/cpuctl -compact
80.It Pa /dev/cpuctl
81control device
82.El
83.Sh HISTORY
84The
85.Nm
86command first appeared in
87.Nx 5.0 .
88