You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
cpuset/doc/cset.html

518 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.1.0" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>cset(1)</title>
</head>
<body>
<div id="header">
<h1>
cset(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>cset -
manage cpusets functions in the Linux kernel
</p>
</div>
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<div class="content"><em>cset</em> [--version | --help | --log]
<em>cset</em> [help &lt;command&gt; | &lt;command&gt; --help]
<em>cset</em> [cset options] &lt;command&gt; [command options] [args]</div></div>
</div>
<h2>DESCRIPTION</h2>
<div class="sectionbody">
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">In general, you need to have root permissions to run cset. The
tool mounts the cpusets filesystem and manipulates it. Non-root users
do not have permission for these actions.</td>
</tr></table>
</div>
<p>Cpuset is a Python application to make using the cpusets facilities in
the Linux kernel easier. The actual included command is called <em>cset</em>
and it allows manipulation of cpusets on the system and provides
higher level functions such as implementation and control of a basic
cpu shielding setup.</p>
<h3>Typical uses of cpuset include</h3>
<dl>
<dt>
Setting up and managing a simple shielded CPU environment
</dt>
<dd>
<p>
The concept of <em>shielded</em> cpus is that a certain number of
cpus are partitioned off on the system and only processes that
are of interest are run on these cpus (i.e., inside the shield).
</p>
<p>For a simple shielded configuration, one typically uses three cpusets:
the root set, a system set and a user set. <em>Cset</em> includes a super
command that implements this strategy and lets you easily manage it.
See <a href="cset-shield.html">cset-shield(1)</a> for more details.</p>
</dd>
<dt>
Setting up and managing a comples shielding environment
</dt>
<dd>
<p>
Shielding can be more complex of course where concepts such as
priority cpusets and intersecting cpuset can be used. You can
use <em>cset</em> to help manage this type of shielding as well. You
will need to use the <a href="cset-set.html">cset-set(1)</a> and <a href="cset-proc.html">cset-proc(1)</a>
subcommands directly to do that.
</p>
</dd>
<dt>
Managing cpusets on the system
</dt>
<dd>
<p>
The cset subcommand <a href="cset-set.html">cset-set(1)</a> allows you to create and
destroy arbitrary cpusets on the system and assign arbitrary
cpus and memory nodes to them. The cpusets so created have to
follow the Linux kernel cpuset rules. See the <a href="cset-set.html">cset-set(1)</a>
subcommand for more details.
</p>
</dd>
<dt>
Managing processes that run on various system cpusets
</dt>
<dd>
<p>
The cset subcommand <a href="cset-proc.html">cset-proc(1)</a> allows you to manage
processes running on various cpusets created on the system.
You can exec new processes in specific cpusets and move tasks
around existing cpusets. See the <a href="cset-proc.html">cset-proc(1)</a> subcommand
for more details.
</p>
</dd>
</dl>
</div>
<h2>OPTIONS</h2>
<div class="sectionbody">
<p>The following generic option flags are available. Additional options
are available per-command, and documented in the command-specific
documentation.</p>
<dl>
<dt>
<em>cset</em> --version
</dt>
<dd>
<p>
Prints the cpuset suite version that the <em>cset</em> program came
from, as well as version of other components used, such as
Python and the kernel.
</p>
</dd>
<dt>
<em>cset</em> --help
</dt>
<dd>
<p>
Prints the synopsis and a list of all commands.
</p>
</dd>
<dt>
<em>cset</em> --log &lt;filename&gt;
</dt>
<dd>
<p>
Creates a log file for the current run. All manner of useful
information is stored in this file. This is usually used to
debug cpuset when things don't go as planned.
</p>
</dd>
<dt>
<em>cset</em> help <em>command</em>
</dt>
<dd>
<p>
Although not strictly an "option", this is a very helpful way
to execute help with cpuset. The command prints out a lengthy
summary of how the specified subcommand works.
</p>
</dd>
</dl>
</div>
<h2>CPUSET COMMANDS</h2>
<div class="sectionbody">
<p>The cpuset commands are divided into groups, according to the primary
purpose of those commands. Following is a short description of each
command. A more detailed description is available in individual
command manpages. Those manpages are named <em>cset-&lt;command&gt;(1)</em>. The
first command, <em>help</em>, is especially useful as it prints out a long
summary of what a particular command does.</p>
<dl>
<dt>
<em>cset help</em>
</dt>
<dd>
<p>
print the detailed command usage
</p>
</dd>
<dt>
<em>cset version</em>
</dt>
<dd>
<p>
display version information
</p>
</dd>
<dt>
<em>cset copyright</em>
</dt>
<dd>
<p>
display copyright information
</p>
</dd>
<dt>
<em>cset shield</em>
</dt>
<dd>
<p>
supercommand to set up and manage basic shielding (see
<a href="cset-shield.html">cset-shield(1)</a>)
</p>
</dd>
<dt>
<em>cset set</em>
</dt>
<dd>
<p>
create, modify and destroy cpusets (see <a href="cset-set.html">cset-set(1)</a>)
</p>
</dd>
<dt>
<em>cset proc</em>
</dt>
<dd>
<p>
create and manage processes within cpusets (see
<a href="cset-proc.html">cset-proc(1)</a>)
</p>
</dd>
</dl>
</div>
<h2>LICENSE</h2>
<div class="sectionbody">
<p>Cpuset is licensed under the GNU GPL V2 only.</p>
</div>
<h2>COPYRIGHT</h2>
<div class="sectionbody">
<p>Copyright (c) 2008 Novell Inc.</p>
</div>
<h2>AUTHOR</h2>
<div class="sectionbody">
<p>Written by Alex Tsariounov &lt;alext@novell.com&gt;.</p>
<p>Some substrate code and ideas were taken from the excellent Stacked
GIT (stgit) v0.13 (see http://gna.org/projects/stgit and
http://www.procode.org/stgit). Stacked GIT is under GPL V2 or later.</p>
</div>
<h2>SEE ALSO</h2>
<div class="sectionbody">
<p><a href="cset-set.html">cset-set(1)</a>, <a href="cset-proc.html">cset-proc(1)</a>, <a href="cset-shield.html">cset-shield(1)</a>, <a href="taskset.html">taskset(1)</a>,
<a href="chrt.html">chrt(1)</a></p>
<p>/usr/src/linux/Documentation/cpusets.txt</p>
</div>
<div id="footer">
<div id="footer-text">
Version 1.0<br />
Last updated 30-May-2008 14:33:24 MDT
</div>
</div>
</body>
</html>