vhost-test: Add MoonGen lua script for perf profiling

mg.lua is a MoonGen script dedicated to forwarding rate
and drop rate measurement.
It is sort of clever at finding which points to plot in
order to discover interesting behaviors.

Change-Id: I40c9ce4da27f3c13c27a8b3214c96298683c2658
Signed-off-by: Pierre Pfister <ppfister@cisco.com>

1 files changed, 24 insertions, 5 deletions

diff --git a/vhost-test/README.md b/vhost-test/README.md
index ee5f56f..5564b18 100644
--- a/vhost-test/README.md
+++ b/vhost-test/README.md
@@ -52,11 +52,30 @@ Finally, when you are done, you can stop the VMs.
 
 $ ./vhost.sh stop
 
-## Traffic Generation
-
-Traffic generation is, for now, out of the scope of this script.
-You are supposed to update ./conf.sh by setting up the right parameters.
-Use the traffic generator you like to test the perfs.
+## Traffic Generation with MoonGen
+
+mg.lua is intended to be used with the MoonGen packet generator.
+This script measures packet loss and forwarding with a user-defined
+granularity. The script keeps running while consecutive measures are
+too far on both Tx axis (--maxRateInterval option) or on the drop rate
+axis (--targetDropRateRatio). The latter is a ratio instead of an interval,
+as the packet drop is mostly a logarithmic value.
+
+The script is used as follows:
+sudo /path/to/MoonGen ./mg.lua <options>
+
+Mandatory options are:
+--rxport <id> MoonGen's rx port index
+--txport <id> MoonGen's tx port index
+--dst <hwaddr> Frame's destination L2 address
+
+Other options are:
+--duration <seconds> Each measurement duration
+--frameSize <bytes> Each frame size
+--maxRateInterval <%> Max Tx interval between measure
+--targetDropRateRatio <ratio> Max ratio between two drop rate measures
+--minRateInterval <%> Min Tx interval (Will override drop ratio in case of non-continuous)
+--out <file> Output file
 
 ## Administrativa