aboutsummaryrefslogtreecommitdiffstats
path: root/docs/man
diff options
context:
space:
mode:
authorGeorge Dunlap <george.dunlap@eu.citrix.com>2012-03-14 14:06:04 +0000
committerGeorge Dunlap <george.dunlap@eu.citrix.com>2012-03-14 14:06:04 +0000
commite05b3ee53b7d27e82f1227adf398d46a8511f9d9 (patch)
treea0a74b4ceac8e2bb45c317f36c4110fdfa409756 /docs/man
parent266e2c6682517f56310e5fb2c7890a286d0499a6 (diff)
downloadxen-e05b3ee53b7d27e82f1227adf398d46a8511f9d9.tar.gz
xen-e05b3ee53b7d27e82f1227adf398d46a8511f9d9.tar.bz2
xen-e05b3ee53b7d27e82f1227adf398d46a8511f9d9.zip
xl: Implement sched-credit schedule parameter command-line interface
Add features to the sched-credit interface to allow querying and displaying scheduler parameters. Signed-off-by: George Dunlap <george.dunlap@eu.citrix.com> Acked-by: Ian Jackson <ian.jackson@eu.citrix.com> Committed-by: Ian Jackson <ian.jackson@eu.citrix.com>
Diffstat (limited to 'docs/man')
-rw-r--r--docs/man/xl.pod.147
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 7802a027c8..2ab8418a00 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -714,6 +714,53 @@ no upper cap.
Restrict output to domains in the specified cpupool.
+=item B<-s>, B<--schedparam>
+
+Specify to list or set pool-wide scheduler parameters.
+
+=item B<-t TSLICE>, B<--tslice_ms=TSLICE>
+
+Timeslice tells the scheduler how long to allow VMs to run before
+pre-empting. The default is 30ms. Valid ranges are 1ms to 1000ms.
+The length of the timeslice (in ms) must be higher than the length of
+the ratelimit (see below).
+
+=item B<-r RLIMIT>, B<--ratelimit_us=RLIMIT>
+
+Ratelimit attempts to limit the number of schedules per second. It
+sets a minimum amount of time (in microseconds) a VM must run before
+we will allow a higher-prioirty VM to pre-empt it. The default value
+is 1000 microseconds (1ms). Valid range is 100 to 500000 (500ms).
+The ratelimit length must be lower than the timeslice length.
+
+=back
+
+B<COMBINATION>
+
+The following is the effect of combining the above options:
+
+=over 4
+
+=item B<E<lt>nothingE<gt>> : List all domain params and sched params from all pools
+
+=item B<-d [domid]> : List domain params for domain [domid]
+
+=item B<-d [domid] [params]> : Set domain params for domain [domid]
+
+=item B<-p [pool]> : list all domains and sched params for [pool]
+
+=item B<-s> : List sched params for poolid 0
+
+=item B<-s [params]> : Set sched params for poolid 0
+
+=item B<-p [pool] -s> : List sched params for [pool]
+
+=item B<-p [pool] -s [params]> : Set sched params for [pool]
+
+=item B<-p [pool] -d>... : Illegal
+
+=item
+
=back
=item B<sched-credit2> [I<OPTIONS>]