bitkeeper revision 1.1159.170.109 (424d462b3t7TNRulCLgZcZNC5I8oew)

Added a very brief usage guide on the sedf scheduler.

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/misc/sedf_scheduler_mini-HOWTO.txt b/docs/misc/sedf_scheduler_mini-HOWTO.txt
new file mode 100644
index 0000000000..ad3cc62e1f
--- /dev/null
+++ b/docs/misc/sedf_scheduler_mini-HOWTO.txt
@@ -0,0 +1,44 @@
+sEDF scheduler
+--------------
+Author:
+   Stephan.Diestelhorst@{cl.cam.ac.uk, inf.tu-dresden.de}
+   
+Overview:
+  This scheduler provides weighted CPU sharing in an intuitive way and
+  uses realtime-algorithms to ensure time guarantees.
+
+Usage:
+   -add "sched=sedf" on Xen's boot command-line
+   -create domains as usual
+   -use "xm sedf <dom-id> <period> <slice> <latency-hint> <extra> <weight>"
+    Where:
+      -period/slice are the normal EDF scheduling parameters in nanosecs
+      -latency-hint is the scaled period in case the domain is doing heavy I/O
+         (unused by the currently compiled version)
+      -extra is a flag (0/1), which controls whether the domain can run in
+       extra-time
+      -weight is mutually exclusive with period/slice and specifies another
+       way of setting a domains cpu slice
+
+Examples:
+ normal EDF (20ms/5ms):
+  xm sedf <dom-id> 20000000 5000000 0 0 0
+  
+ best-effort domains (i.e. non-realtime):
+  xm sedf <dom-id> 20000000 0 0 1 0
+ 
+ normal EDF (20ms/5ms) + share of extra-time:
+  xm sedf <dom-id> 20000000 5000000 0 1 0
+  
+ 4 domains with weights 2:3:4:2
+  xm sedf <d1> 0 0 0 0 2
+  xm sedf <d2> 0 0 0 0 3
+  xm sedf <d3> 0 0 0 0 4
+  xm sedf <d4> 0 0 0 0 2
+  
+ 1 fully-specified (10ms/3ms) domain, 3 other domains share
+ available rest in 2:7:3 ratio:
+  xm sedf <d1> 10000000 3000000 0 0 0
+  xm sedf <d2> 0 0 0 0 2
+  xm sedf <d3> 0 0 0 0 7
+  xm sedf <d4> 0 0 0 0 3
\ No newline at end of file