summaryrefslogtreecommitdiffstats
path: root/sys-utils/chcpu.8
blob: b8a02bffd78d87017e7c5df3b87dd13964119c7a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
'\" t
.\"     Title: chcpu
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-10-23
.\"    Manual: System Administration
.\"    Source: util-linux 2.39.3
.\"  Language: English
.\"
.TH "CHCPU" "8" "2023-10-23" "util\-linux 2.39.3" "System Administration"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
chcpu \- configure CPUs
.SH "SYNOPSIS"
.sp
\fBchcpu\fP \fB\-c\fP|\fB\-d\fP|\fB\-e\fP|\fB\-g\fP \fIcpu\-list\fP
.sp
\fBchcpu\fP \fB\-p\fP \fImode\fP
.sp
\fBchcpu\fP \fB\-r\fP|\fB\-h\fP|\fB\-V\fP
.SH "DESCRIPTION"
.sp
\fBchcpu\fP can modify the state of CPUs. It can enable or disable CPUs, scan for new CPUs, change the CPU dispatching \fImode\fP of the underlying hypervisor, and request CPUs from the hypervisor (configure) or return CPUs to the hypervisor (deconfigure).
.sp
Some options have a \fIcpu\-list\fP argument. Use this argument to specify a comma\-separated list of CPUs. The list can contain individual CPU addresses or ranges of addresses. For example, \fB0,5,7,9\-11\fP makes the command applicable to the CPUs with the addresses 0, 5, 7, 9, 10, and 11.
.SH "OPTIONS"
.sp
\fB\-c\fP, \fB\-\-configure\fP \fIcpu\-list\fP
.RS 4
Configure the specified CPUs. Configuring a CPU means that the hypervisor takes a CPU from the CPU pool and assigns it to the virtual hardware on which your kernel runs.
.RE
.sp
\fB\-d\fP, \fB\-\-disable\fP \fIcpu\-list\fP
.RS 4
Disable the specified CPUs. Disabling a CPU means that the kernel sets it offline.
.RE
.sp
\fB\-e\fP, \fB\-\-enable\fP \fIcpu\-list\fP
.RS 4
Enable the specified CPUs. Enabling a CPU means that the kernel sets it online. A CPU must be configured, see \fB\-c\fP, before it can be enabled.
.RE
.sp
\fB\-g\fP, \fB\-\-deconfigure\fP \fIcpu\-list\fP
.RS 4
Deconfigure the specified CPUs. Deconfiguring a CPU means that the hypervisor removes the CPU from the virtual hardware on which the Linux instance runs and returns it to the CPU pool. A CPU must be offline, see \fB\-d\fP, before it can be deconfigured.
.RE
.sp
\fB\-p\fP, \fB\-\-dispatch\fP \fImode\fP
.RS 4
Set the CPU dispatching \fImode\fP (polarization). This option has an effect only if your hardware architecture and hypervisor support CPU polarization. Available \fImodes\fP are:
.sp
\fBhorizontal\fP
.RS 4
The workload is spread across all available CPUs.
.RE
.sp
\fBvertical\fP
.RS 4
The workload is concentrated on few CPUs.
.RE
.RE
.sp
\fB\-r\fP, \fB\-\-rescan\fP
.RS 4
Trigger a rescan of CPUs. After a rescan, the Linux kernel recognizes the new CPUs. Use this option on systems that do not automatically detect newly attached CPUs.
.RE
.sp
\fB\-h\fP, \fB\-\-help\fP
.RS 4
Display help text and exit.
.RE
.sp
\fB\-V\fP, \fB\-\-version\fP
.RS 4
Print version and exit.
.RE
.SH "EXIT STATUS"
.sp
\fBchcpu\fP has the following exit status values:
.sp
\fB0\fP
.RS 4
success
.RE
.sp
\fB1\fP
.RS 4
failure
.RE
.sp
\fB64\fP
.RS 4
partial success
.RE
.SH "AUTHORS"
.sp
.MTO "heiko.carstens\(atde.ibm.com" "Heiko Carstens" ""
.SH "COPYRIGHT"
.sp
Copyright IBM Corp. 2011
.SH "SEE ALSO"
.sp
\fBlscpu\fP(1)
.SH "REPORTING BUGS"
.sp
For bug reports, use the issue tracker at \c
.URL "https://github.com/util\-linux/util\-linux/issues" "" "."
.SH "AVAILABILITY"
.sp
The \fBchcpu\fP command is part of the util\-linux package which can be downloaded from \c
.URL "https://www.kernel.org/pub/linux/utils/util\-linux/" "Linux Kernel Archive" "."