summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVincent Guittot <vincent.guittot@linaro.org>2015-08-24 14:18:28 +0200
committerVincent Guittot <vincent.guittot@linaro.org>2015-08-24 14:18:28 +0200
commitdc08dc380cb32c7a9341176709334a363df3dcd5 (patch)
tree9328c10f12b83f6e5a77c8fd08c4d83d843343bc /doc
parent3d5b0ebcd48b818b987802fd216121b66113a305 (diff)
workgen: Add IO-bounded and memory-bounded eventslinaro-v1.0
Add 2 new kind of event for running a memory or a io bounded load. "mem" name for a load is memory bounded, and "iorun" name for a load is io bounded. The default file to be written to create the load is /dev/null and the device/file could be specified with "io_device" key in "global" section. The size of per-thread memory buffer to create IO/memory load could also be specified with "mem_buffer_size" in the same section. Signed-off-by: Pi-Cheng Chen <pi-cheng.chen@linaro.org> [ replace Text by String in tutorial.txt] Signed-off-by: Vincent Guittot <vincent.guittot@linaro.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/tutorial/example6.json29
-rw-r--r--doc/tutorial.txt18
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/examples/tutorial/example6.json b/doc/examples/tutorial/example6.json
new file mode 100644
index 0000000..06899eb
--- /dev/null
+++ b/doc/examples/tutorial/example6.json
@@ -0,0 +1,29 @@
+{
+ /*
+ * Simple use case which creates CPU-, memory-,
+ * and IO-bouned load for 2 seconds duration.
+ */
+ "tasks" : {
+ "thread0" : {
+ "instance" : 1,
+ "loop" : -1,
+ "run" : 1000,
+ "mem" : 1000,
+ "sleep" : 5000,
+ "iorun" : 100000
+ }
+ },
+ "global" : {
+ "duration" : 2,
+ "calibration" : "CPU0",
+ "default_policy" : "SCHED_OTHER",
+ "pi_enabled" : false,
+ "lock_pages" : false,
+ "logdir" : "./",
+ "log_basename" : "rt-app2",
+ "ftrace" : true,
+ "gnuplot" : true,
+ "io_device" : "/dev/null",
+ "mem_buffer_size" : 1048576
+ }
+}
diff --git a/doc/tutorial.txt b/doc/tutorial.txt
index b2b0971..9c47178 100644
--- a/doc/tutorial.txt
+++ b/doc/tutorial.txt
@@ -81,6 +81,14 @@ case. Default value is False.
* gnuplot : Boolean. if True, it will create a gnu plot compatible file for
each threads (see gnuplot section for more details). Default value is False.
+"io_device" : Text. Path to the file which will be written to create IO-bounded
+busy loop. Specify it carefully since it might damage the specified file.
+Default value is "/dev/null".
+
+"mem_buffer_size" : Integer. The size of per-thread memory buffer in byte being
+used to create IO-bounded and memory-bounded busy loop. Default value is
+4194304(4MB).
+
*** default global object:
"global" : {
"duration" : -1,
@@ -93,6 +101,8 @@ each threads (see gnuplot section for more details). Default value is False.
"log_basename" : "rt-app",
"ftrace" : false,
"gnuplot" : false,
+ "io_device" : "/dev/null"
+ "mem_buffer_size" : 4194304
}
**** tasks object ****
@@ -187,6 +197,14 @@ frequency or the compute capacity of the CPU.
* sleep : Integer. Emulate the sleep of a task. The duration is defined in
usec.
+* mem : Integer. Emulate the memory write operation. The value defines the size
+in byte to be written into the memory buffer. The size of the memory buffer is
+defined by "mem_buffer_size" in "global" object.
+
+* iorun : Integer. Emulate the IO write operation. The value defined the size
+in byte to be write into the IO device specified by "io_device" in "global"
+object.
+
* timer : Object. Emulate the wake up of the thread by a timer. Timer differs
from sleep event by the start time of the timer duration. Sleep duration starts
at the beginning of the sleep event whereas timer duration starts at the end of