Skip to content

Latest commit

 

History

History
74 lines (54 loc) · 3.51 KB

README.md

File metadata and controls

74 lines (54 loc) · 3.51 KB
Raw

Simple MoonGen Interface

This interface is supposed to be an easier to understand, use and maintain alternative to the Lua-scripts needed to run MoonGen. Instead, these scripts are replaced by configuration files containing flows in a BibTeX-like syntax.

Getting started - examples

sudo ./moongen-simple start load-latency:0:1:rate=1000,timeLimit=10m

Similar to examples/l3-load-latency.lua with rate set to 1000 mbit/s, but stops automatically after 10 minutes. Will send on port 0 and receive on port 1. Packet content is defined in flows/examples.lua.

For quick adjustments the packet content can also be changed from the command-line using:

sudo ./moongen-simple start load-latency:0:1:rate=1000,timeLimit=10m:udpSrc=4321

More info on options like rate=1000, timeLimit=10m and similar options can be found using ./moongen-simple help options.

More Examples

  • sudo ./moongen-simple start udp-simple:0:1:rate=1000mbit/s,ratePattern=poisson
  • sudo ./moongen-simple start qos-foreground:0:1 qos-background:0:1
  • sudo ./moongen-simple start udp-load:0:1:rate=1mp/s,mode=all,timestamp
  • sudo ./moongen-simple start "udp-load:0::rate=1000:udpDst=range(100,200)"
  • sudo ./moongen-simple start "load-latency:0,1:0,1:rate=1000:ip4Dst=ip'192.168.0.1'"

Commands

Start

sudo ./moongen-simple start <flow> [<flow>] ...
<flow> -> <name>:[<tx-ports>]:[<rx-ports>]:[<options>]:[<overrides>]

Start all the flows supplied as arguments. All arguments besides the name can be ,-separated lists, e.g., flow:0,1 sends flow on ports 0 and 1. You can pass the same interface multiple times to transmit the same flow from multiple cores. Trailing : can be omitted.

See ./moongen-simple help options for a list of options.

overrides can be used to override fields in the flow definition using the same syntax as in the flow configuration file.

List

./moongen-simple list [<entry>] ...

Show a tabular view of all flows available in the directories or files passed (default is flows). Useful to remember the name of a particular flow or find the file a flow resides in.

Debug

./moongen-simple debug <flow>

Shows hex-dumps of the packets resulting from a certain flow without sending anything. Can be used to test the results of more complicated flow configurations. Will also adapt to some options and all overwrites passed.

See start command for syntax of <flow>.

Help

All commands can be invoked with a -h flag to show info on available options. Additionally calling ./moongen-simple help will list all available help texts that can be read using ./moongen-simple help <topic>.

Configuration

First, all configuration files in a directory (excluding subdirectories) are scanned. The flows can then be started by name. The following Flow is meant as a demonstration of capabilities. Look in MoonGen/flows for useful base flows or use ./moongen-simple help configuration for more information.

Flow{"example", Packet.Udp{
    ethSrc = txQueue(),
    ethDst = arp(ip"10.1.0.1"),
    ip4Src = list{
      ip"10.1.0.0", ip"10.1.1.1",
      ip"11.0.1.0", ip"11.1.0.1"
    },
    ip4Dst = ip"10.1.0.1",
    udpSrc = range(1000, 2000),
    udpDst = 1234
  },
  mode = "random",
  rate = 1234,
  timestamp = true
}

The protocol fields rely on libmoon's magic protocol stack which means you'll unfortunately have to dig through the libmoon protocol definitions. Everything that's available as setXXX there is available as variable here.