rust-tcp-io-perf

This repo contains programs to benchmark how much bandwidth we effectively have available on a communication channel and what's the latency on that channel.

It is froked from rust-tcp-io-perf and used to measure the network performance of Hermit.

Bandwidth measure

We measure the effective bandwidth available on a communication channel.

We run a server and a client at the two ends of the channel, and start sending big quantities of data from one end to the other. On the server side we can then measure (only in stable state) how much data we have received in how much time and derive an approximation of the bandwidth.

Latency measure

We measure the latency between the two machines at the end of a communication channel.

We run a server and a client at the two ends of the channel, and start sending data from one end to the other and back. On the client side we can then measure the roundtrip time of every message sent and derive latency info.

Instructions

For both programs, you can run them the same way. We will use bw as example. To run latency just replace bw with latency whenever it appears in the instructions.

Running .rs directly

Prerequisites

Have Rust and Cargo correctly installed on your machine

Instructions

Run server

Go on the machine where you want to launch the server (or ssh into it)
Open a terminal
cd into the inner code folder
Run cargo run --bin server-bw --release (or compile and run, meaning cargo build --bin server-bw --release and once compiled ./target/release/server-bw). You can specify the port you want to listen on with -p <port_number>.

Run client

Go on the machine where you want to launch the client (or ssh into it)
Open a terminal
cd into the inner code folder
Run cargo run --bin client-bw --release (or compile and run, meaning cargo build --bin client-bw --release and once compiled ./target/release/client-bw). You can specify a bunch of parameters. Run the program with the -h option to see available params. Make sure you specify the right address and port to connect to the server, using parameters -a <address> -p <port>.

You should see the client tracking progress, and when he's done you should see the server printing a visual distribution of data, followed by a summary with the bandwidth information.

If you want to test the two-way communication, then setup 2 servers and then run the 2 clients together.

Running via scripts

I have provided scripts to run the benchmarks automatically, runner.py and runner_bidirectional.py. For these scripts you will need to edit the configuration file. Change values in config_bw.config (or config_latency.config), or create a config file in the same format with the same keys and change values. You can specify the program to test (whether bw or latency) in your config file.

The config file is important because it will contain a bunch of things like machines names, ssh keys, username to use for the ssh, that will be necessary to run your programs.

Prerequisites

Make sure you can ssh into the machines you want to use for your benchmark.
Make sure you have set up the ssh connections correctly and have the machines in your known host and have the ssh keys somewhere in your pc (or the machine you will start the script from).

Instructions

For both scripts, run: python <script> <config_file_location>.

Scripts

runner.py: This script will run the benchmark remotely with a client and a server
runner_bidirectional.py: This script will run the benchmark remotely with 2 clients and 2 servers (a client and a server on each of the 2 machines) in order to test bidirectional communication.

If in your config file you specify PLOT=1 you will also see a summary plot of the samples. See the Visualizing results chapter for details.

Visualizing results

Prerequisites

Have matplotlib installed

Description

There is an additional runnable tool which is plotter.py. It takes the output of our .rs program as input and produces a plot of bandwidth\latency CDF.

...Note: This is not very reliable for bandwidth usually, especially when testing two-way communications, given that we may see higher spikes only because we had more stuff waiting to be processed in our server than what was effectively sent in that time frame.

Instructions

python plotter.py <file_with_server.rs_output>

Get the file you need by simply redirecting to a file the output of:

server.rs for bw
client.rs for latency

Alternatively, run you runner.py scripts normally, but change the config value of PLOT to PLOT=1