From b2f8b02ec27dfec9cbd23573f47aba494f2e9b5f Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 25 Apr 2014 13:27:25 +0200
Subject: core: expose CFS CPU time quota as high-level unit properties

---
 man/systemd-system.conf.xml      | 12 ++++++++++
 man/systemd.resource-control.xml | 52 ++++++++++++++++++++++++++++++++++++----
 2 files changed, 59 insertions(+), 5 deletions(-)

(limited to 'man')

diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml
index e2b2bd8b6f..3814bd2ad8 100644
--- a/man/systemd-system.conf.xml
+++ b/man/systemd-system.conf.xml
@@ -301,6 +301,18 @@
                                 above.</para></listitem>
                         </varlistentry>
 
+                        <varlistentry>
+                                <term><varname>DefaultCPUQuotaPeriodSec=</varname></term>
+
+                                <listitem><para>Sets the default CPU
+                                quota period. Defaults to 100ms. This
+                                controls th global default for the
+                                <varname>CPUQuotaPeriodSec=</varname>
+                                setting of units, see
+                                <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                                for details.</para></listitem>
+                        </varlistentry>
+
                         <varlistentry>
                                 <term><varname>DefaultTimeoutStartSec=</varname></term>
                                 <term><varname>DefaultTimeoutStopSec=</varname></term>
diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml
index a51e600ebb..5a996fd6df 100644
--- a/man/systemd.resource-control.xml
+++ b/man/systemd.resource-control.xml
@@ -117,11 +117,53 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
         <term><varname>CPUShares=<replaceable>weight</replaceable></varname></term>
 
         <listitem>
-          <para>Assign the specified overall CPU time share weight to
-          the processes executed. Takes an integer value. This
-          controls the <literal>cpu.shares</literal> control group
-          attribute, which defaults to 1024. For details about this
-          control group attribute, see <ulink
+          <para>Assign the specified CPU time share weight to the
+          processes executed. Takes an integer value. This controls
+          the <literal>cpu.shares</literal> control group attribute,
+          which defaults to 1024. For details about this control group
+          attribute, see <ulink
+          url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>
+          The available CPU time is split up among all units within a
+          slice relative to their CPU time share weight.</para>
+
+          <para>Implies <literal>CPUAccounting=true</literal>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>CPUQuota=</varname></term>
+
+        <listitem>
+          <para>Assign the specified CPU time quota to the processes
+          executed. Takes a percentage value (suffixed with "%") or an
+          absolute time (suffixed by one of the common time units, us,
+          ms, s, ...). The percentage specifies how much CPU time the
+          unit shall get at maximum, relative to the total CPU time
+          available on one CPU. Use values > 100% for alloting CPU
+          time on more than one CPU. If an absolute time is specified
+          the processes of this unit will get this much absolute time
+          within each quota period, at maximum. This controls the
+          <literal>cpu.cfs_quota_us</literal> control group
+          attribute. For details about this control group attribute,
+          see <ulink
+          url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
+
+          <para>Example: <varname>CPUShares=20%</varname> ensures that
+          the executed processes will never get more than 20% CPU time
+          on one CPU.</para>
+
+          <para>Implies <literal>CPUAccounting=true</literal>.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><varname>CPUQuotaPeriodSec=</varname></term>
+
+        <listitem>
+          <para>Specify the CPU quota period to use. Defaults to
+          100ms. This controls the <literal>cpu.cfs_period_us</literal>
+          control group attribute. For details about this control
+          group attribute, see <ulink
           url="https://www.kernel.org/doc/Documentation/scheduler/sched-design-CFS.txt">sched-design-CFS.txt</ulink>.</para>
 
           <para>Implies <literal>CPUAccounting=true</literal>.</para>
-- 
cgit v1.2.3-54-g00ecf