Skip to content

Commit

Permalink
Word wrapped the readme
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.bramp.net:8080/svn/PhD/Work/userspace/threadnetperf@2716 e02701c3-087c-644a-a2a3-551e05f81084
  • Loading branch information
bramp committed May 29, 2009
1 parent b1e411c commit 63ad10d
Showing 1 changed file with 44 additions and 22 deletions.
66 changes: 44 additions & 22 deletions README.txt
@@ -1,15 +1,27 @@
****** Threadnetperf ******
****** Threadnetperf ******
A multi-threaded network benchmark tool
by Andrew Brampton <brampton@gmail.com> (2007-2009)
and Mathew Faulkner (2007-2009)

Threadnetperf is a highly customisable high performance network benchmarking tool. The key difference from previous tools is that the user is able to control how many threads threadnetperf uses, as well as which cores these threads are pinned to. This tool was useful in our research for measuring the effect of sending or receiving from one core, and having the OS network stack run on another core. Additionally the tool can be configured to use an unlimited number of connections, threads or processes, which scale considerably well due to the use of the epoll API.

Threadnetperf has previously worked on Windows, Linux, and FreeBSD, however, we do not test it very rigorously so one of these platforms may be broken. All patches are welcome.

To build on a *nix style system just use the simple "Makefile" by executing the command "make" or "gmake". To build on Windows just use the provided threadnetperf.2008.sln file.

All the commands of Threadnetperf are documented within the application, but a quick overview is here:
Threadnetperf is a highly customisable high performance network benchmarking
tool. The key difference from previous tools is that the user is able to control
how many threads threadnetperf uses, as well as which cores these threads are
pinned to. This tool was useful in our research for measuring the effect of
sending or receiving from one core, and having the OS network stack run on
another core. Additionally the tool can be configured to use an unlimited number
of connections, threads or processes, which scale considerably well due to the
use of the epoll API.

Threadnetperf has previously worked on Windows, Linux, and FreeBSD, however, we
do not test it very rigorously so one of these platforms may be broken. All
patches are welcome.

To build on a *nix style system just use the simple "Makefile" by executing the
command "make" or "gmake". To build on Windows just use the provided
threadnetperf.2008.sln file.

All the commands of Threadnetperf are documented within the application, but a
quick overview is here:

Usage: threadnetperf [options] tests
Usage: threadnetperf -D [options]
Expand All @@ -24,39 +36,49 @@ Usage: threadnetperf -D [options]
-n Disable Nagle's algorithm (e.g no delay)
-p port Set the port number for the first server thread to use
-s size Set the send/recv size
-T Timestamp packets, and measure latency (only available on *nix)
-T Timestamp packets, and measure latency (only on *nix)
-t Use TCP
-r Packets per second rate (default: ~0)
-u Use UDP
-v Verbose
-V Display version only

tests Combination of cores and clients
tests Core numbers are masks, for example 1 is core 0, 3 is core 0 and core 1
tests Core numbers are masks, for example 1 is core 0, 3 is core 0
and core 1
N{c-s} N connections
c client cores mask
s server cores mask

You can run tests locally, or across two machines. Here are some examples:

threadnetperf -n -s 10000 1{1-1}

Will run a local TCP test, with Nagle's algorithm disabled, a send size of 10,000, and 1 TCP connection between cores 0 and 0.


Will run a local TCP test, with Nagle's algorithm disabled, a send size of
10,000, and 1 TCP connection between cores 0 and 0.

threadnetperf 10{1-1} 10{2-2} 10{4-4}

Will again run a local TCP test, however this time 10 connection from core 0 to core 0, 10 connections from core 1 to core 1, and 10 connections from core 2 to core 2

To run across a network just start the threadnetperf daemon on one of the machines like so:

Will again run a local TCP test, however this time 10 connection from core 0 to
core 0, 10 connections from core 1 to core 1, and 10 connections from core 2 to
core 2

To run across a network just start the threadnetperf daemon on one of the
machines like so:

threadnetperf -D

and on the other machine execute:

threadnetperf -H serverIP 1{1-2}

which will conduct a TCP test from the client to the server, with one thread executing on client's core 0, and the server's core 1.
which will conduct a TCP test from the client to the server, with one thread
executing on client's core 0, and the server's core 1.

There is no need to give the threadnetperf daemon any options, as the options configured on the server will be passed over the network. This make running many tests very easy as the daemon will continue to wait for new tests until it is told otherwise.
There is no need to give the threadnetperf daemon any options, as the options
configured on the server will be passed over the network. This make running many
tests very easy as the daemon will continue to wait for new tests until it is
told otherwise.

If you find this tool useful, or you have any suggestions for improvements then please contact us.
If you find this tool useful, or you have any suggestions for improvements then
please contact us.

0 comments on commit 63ad10d

Please sign in to comment.