summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Sommerseth <davids@redhat.com>2010-02-24 17:29:46 +0100
committerDavid Sommerseth <davids@redhat.com>2010-02-24 17:29:46 +0100
commitbd43983e36605481f3732925d8bc0d3eb0557d4b (patch)
tree471a175e4ced2ee67566993773decd269b93a6aa
parent94d8566d6ccaf090ad44611a6f99a3b540798029 (diff)
downloadrt-tests-bd43983e36605481f3732925d8bc0d3eb0557d4b.tar.gz
Updated hackbench man page with some examples and some extra details re. fds
-rw-r--r--src/hackbench/hackbench.838
1 files changed, 37 insertions, 1 deletions
diff --git a/src/hackbench/hackbench.8 b/src/hackbench/hackbench.8
index bedb2fc..d86c52f 100644
--- a/src/hackbench/hackbench.8
+++ b/src/hackbench/hackbench.8
@@ -35,7 +35,10 @@ How many messages each sender/receiver pair should send
Defines how many groups of senders and receivers should be started
.TP
.B \-f, \-\-fds=<number of file descriptors>
-Defines how many file descriptors each group of senders and receivers should use
+Defines how many file descriptors each child should use.
+Note that the effective number will be twice the amount you set here,
+as the sender and receiver children will each open the given amount of
+file descriptors.
.TP
.B \-T, \-\-threads
Each sender/receiver child will be a POSIX thread of the parent.
@@ -46,6 +49,39 @@ Hackbench will use fork() on all children (default behaviour)
.B \-\-help
.br
Shows a simple help screen
+.SH "EXAMPLES"
+.LP
+Running hackbench without any options will give default behaviour,
+using fork() and sending data between senders and receivers via sockets.
+.LP
+user@host: ~ $ hackbench
+.br
+Running in process mode with 10 groups using 40 file descriptors each (== 400 tasks)
+.br
+Each sender will pass 100 messages of 100 bytes
+.br
+Time: 0.890
+.LP
+To use pipes between senders and receivers and using threads instead of fork(), run
+.LP
+user@host: ~ $ hackbench \-\-pipe \-\-threads (or hackbench \-p \-T)
+.br
+Running in threaded mode with 10 groups using 40 file descriptors each (== 400 tasks)
+.br
+Each sender will pass 100 messages of 100 bytes
+.br
+Time: 0.497
+.LP
+Set the datasize to 512 bytes, do 200 messages per sender/receiver pairs and use 15 groups
+using 25 file descriptors per child, in process mode.
+.LP
+user@host: ~ $ hackbench \-s 512 \-l 200 \-g 15 \-f 25 \-P
+.br
+Running in process mode with 15 groups using 50 file descriptors each (== 750 tasks)
+.br
+Each sender will pass 200 messages of 512 bytes
+.br
+Time: 4.497
.SH "AUTHORS"
.LP
hackbench was written by Rusty Russell <rusty@rustcorp.com.au>