Version 2 (modified by, 9 years ago) (diff)


Appendix: Hints and Explanations

A. LabWiki Script for the LoadBalancer

defProperty('theSender', "outside-loadbaltest", "ID of sender node")
defProperty('theReceiver', "inside-loadbaltest", "ID of receiver node")
defProperty('theSwitch',"switch-loadbaltest","ID of switch node")
defProperty('setinterval','1.0',"Time between iperf")
defProperty('serverip', "","Server interface IP")
defProperty('clientip', "","Client interface IP")
defProperty('setbandwidth', "100m", "Throughput of Sender")
defApplication('trace') do |app|
  app.description = 'Packet capture'
  app.binary_path = "/usr/bin/trace-oml2"
  app.defProperty('filter', 'Filter expression BPFEXP', '-f', {:type => :string, :mnemonic => 'f'})
  app.defProperty('interface', 'Interface to trace', '-i',{:type => :string, :mnemonic => 'i', :default => '"eth0"'})
  app.defProperty('config', 'config file to follow', '--oml-config',{:type => :string, :default => '"/tmp/monitor/conf.xml"'})

app.defMeasurement("ip") do |m|
    m.defMetric('pktid',    :uint64, ' internal packet ID to link MPs')
    m.defMetric('ip_tos',   :uint32, ' Type of Service')
    m.defMetric('ip_len',   :uint32, ' Total Length')
    m.defMetric('ip_id',    :int32,  ' Identification')
    m.defMetric('ip_off',   :uint32, ' IP Fragment offset (and flags)')
    m.defMetric('ip_ttl',   :uint32, ' Time to Live')
    m.defMetric('ip_proto', :uint32, ' Protocol')
    m.defMetric('ip_sum',   :uint32, ' Checksum')
    m.defMetric('ip_src',   :string, ' Source Address')
    m.defMetric('ip_dst',   :string, ' Destination Address')
    m.defMetric('ip_sizeofpacket', :uint32, ' Size of the Packet')
    m.defMetric('ip_ts',    :double, ' timestamp of the measurement')

defApplication('iperf') do |app| 
  app.description = "Iperf is a traffic generator and bandwidth measurement
tool. It provides generators producing various forms of packet streams and port
for sending these packets via various transports, such as TCP and UDP."
  app.binary_path = "/usr/bin/iperf_oml2"

  #app.defProperty('interval', 'pause n seconds between periodic bandwidth reports', '-i',
   # :type => :double, :unit => "seconds", :default => '1.')
  app.defProperty('len', 'set length read/write buffer to n (default 8 KB)', '-l',
		  :type => :integer, :unit => "KiBytes")
  app.defProperty('print_mss', 'print TCP maximum segment size (MTU - TCP/IP header)', '-m',
		  :type => :boolean)
  app.defProperty('output', 'output the report or error message to this specified file', '-o',
		  :type => :string)
  app.defProperty('port', 'set server port to listen on/connect to to n (default 5001)', '-p',
		  :type => :integer)
  app.defProperty('udp', 'use UDP rather than TCP', '-u',
		  :type => :boolean,
		  :order => 2)
  app.defProperty('window', 'TCP window size (socket buffer size)', '-w',
		  :type => :integer, :unit => "Bytes")
  app.defProperty('bind', 'bind to <host>, an interface or multicast address', '-B',
		  :type => :string)
  app.defProperty('compatibility', 'for use with older versions does not sent extra msgs', '-C',
		  :type => :boolean)
  app.defProperty('mss', 'set TCP maximum segment size (MTU - 40 bytes)', '-M',
		  :type => :integer, :unit => "Bytes")
  app.defProperty('nodelay', 'set TCP no delay, disabling Nagle\'s Algorithm', '-N',
		  :type => :boolean)
  app.defProperty('IPv6Version', 'set the domain to IPv6', '-V',
		  :type => :boolean)
  app.defProperty('reportexclude', 'exclude C(connection) D(data) M(multicast) S(settings) V(server) reports', '-x',
		  :type => :string, :unit => "[CDMSV]")
  app.defProperty('reportstyle', 'C or c for CSV report, O or o for OML', '-y',
		  :type => :string, :unit => "[CcOo]", :default => "o") # Use OML reporting by default

  app.defProperty('server', 'run in server mode', '-s',
		  :type => :boolean)

  app.defProperty('bandwidth', 'set target bandwidth to n bits/sec (default 1 Mbit/sec)', '-b',
		  :type => :string, :unit => "Mbps")
  app.defProperty('client', 'run in client mode, connecting to <host>', '-c',
		  :type => :string,
		  :order => 1)
  app.defProperty('dualtest', 'do a bidirectional test simultaneously', '-d',
		  :type => :boolean)
  app.defProperty('num', 'number of bytes to transmit (instead of -t)', '-n',
		  :type => :integer, :unit => "Bytes")
  app.defProperty('tradeoff', 'do a bidirectional test individually', '-r',
		  :type => :boolean)
  app.defProperty('time', 'time in seconds to transmit for (default 10 secs)', '-t',
		  :type => :integer, :unit => "seconds")
  app.defProperty('fileinput', 'input the data to be transmitted from a file', '-F',
		  :type => :string)
  app.defProperty('stdin', 'input the data to be transmitted from stdin', '-I',
		  :type => :boolean)
  app.defProperty('listenport', 'port to recieve bidirectional tests back on', '-L',
		  :type => :integer)
  app.defProperty('parallel', 'number of parallel client threads to run', '-P',
		  :type => :integer)
  app.defProperty('ttl', 'time-to-live, for multicast (default 1)', '-T',
		  :type => :integer,
		  :default => 1)
  app.defProperty('linux_congestion', 'set TCP congestion control algorithm (Linux only)', '-Z',
		  :type => :boolean)

  app.defMeasurement("application"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('version', :string)
    m.defMetric('cmdline', :string)
    m.defMetric('starttime_s', :integer)
    m.defMetric('starttime_us', :integer)

  app.defMeasurement("settings"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('server_mode', :integer)
    m.defMetric('bind_address', :string)
    m.defMetric('multicast', :integer)
    m.defMetric('multicast_ttl', :integer)
    m.defMetric('transport_protocol', :integer)
    m.defMetric('window_size', :integer)
    m.defMetric('buffer_size', :integer)

  app.defMeasurement("connection"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('connection_id', :integer)
    m.defMetric('local_address', :string)
    m.defMetric('local_port', :integer)
    m.defMetric('remote_address', :string)
    m.defMetric('remote_port', :integer)

  app.defMeasurement("transfer"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('connection_id', :integer)
    m.defMetric('begin_interval', :double)
    m.defMetric('end_interval', :double)
    m.defMetric('size', :uint64)

  app.defMeasurement("losses"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('connection_id', :integer)
    m.defMetric('begin_interval', :double)
    m.defMetric('end_interval', :double)
    m.defMetric('total_datagrams', :integer)
    m.defMetric('lost_datagrams', :integer)

  app.defMeasurement("jitter"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('connection_id', :integer)
    m.defMetric('begin_interval', :double)
    m.defMetric('end_interval', :double)
    m.defMetric('jitter', :double)

  app.defMeasurement("packets"){ |m|
    m.defMetric('pid', :integer)
    m.defMetric('connection_id', :integer)
    m.defMetric('packet_id', :integer)
    m.defMetric('packet_size', :integer)
    m.defMetric('packet_time_s', :integer)
    m.defMetric('packet_time_us', :integer)
    m.defMetric('packet_sent_time_s', :integer)
    m.defMetric('packet_sent_time_us', :integer)


defGroup('Servers', property.theReceiver) do |node|
  node.addApplication("iperf") do |app|
        #app.setProperty('interval', property.setinterval)
        app.measure('transfer', :samples => 1)

defGroup('Sender',property.theSender) do |node|
    node.addApplication("iperf") do |app|
        app.setProperty('parallel', 5)
        app.measure('transfer', :samples => 1)
defGroup('Monitor1', property.theSwitch) do |node|
  node.addApplication("trace") do |app|
    app.setProperty("interface", 'eth1')
    app.setProperty("filter", 'tcp')
     app.setProperty("config", "/tmp/monitor/conf.xml")
    app.measure("tcp", :samples => 1)
defGroup('Monitor', property.theSwitch) do |node|
  node.addApplication("trace") do |app|
    app.setProperty("interface", 'eth3')
    app.setProperty("filter", 'tcp')
     app.setProperty("config", "/tmp/monitor/conf.xml")
    app.measure("tcp", :samples => 1)

onEvent(:ALL_UP_AND_INSTALLED) do |event|
    info "starting"
     after 2 do
    after 100 do
      group ('Sender').stopApplications
    group ('Monitor1').stopApplications
     info "All applications stopped." 
##define the graphs that we want to display##
#defGraph 'Cumulated number of Bytes' do |g|
#'network').select(:oml_ts_server, :tx_bytes, :oml_sender_id)
#  g.caption "Total Bytes"
#  g.type 'line_chart3'
#  g.mapping :x_axis => :oml_ts_server, :y_axis => :tx_bytes, :group_by => :oml_sender_id
#  g.xaxis :legend => 'time', :ticks => {:format => 's'}
#  g.yaxis :legend => '', :ticks => {:format => 'Byte'}

defGraph 'TCP Throughput Bytes-per-Second' do |g|'tcp').select(:oml_ts_server, :tcp_packet_size, :oml_sender_id)
  g.caption "TCP throughput"
  g.type 'line_chart3'
  g.mapping :x_axis => :oml_ts_server, :y_axis => :tcp_packet_size, :group_by => :oml_sender_id
  g.xaxis :legend => 'time', :ticks => {:format => 's'}
  g.yaxis :legend => '', :ticks => {:format => 'Bytes/s'}

B. About the OpenFlow controller load-balancer.rb

  • Trema web site:
  • Treme ruby API document:
  • Functions used in our tutorial:
    • start(): is the function that will be called when the OpenFlow Controller is started. Here in our case, we read the file /tmp/portmap and figures out which OpenFlow port points to which path
    • switch_ready(): is the function that will be called each time a switch connects to the OpenFlow Controller. Here in our case, we allow all non-TCP flows to pass (including ARP and ICMP packets) and ask new inbound TCP flow to go to the controller. We also starts a "timer" function that calls "query_stats()" once every 2 seconds.
    • query_stats(): is the function that sends out a flow_stats_request to get the current statistics about each flow.
    • packet_in(): is the function that will be called each time a packet arrives at the controller. Here in our case, we call "decide_path()" to get path decisions, then send flow entry back to the OpenFlow Switch to instruct the switch which path to take for this new TCP flow.
    • stats_reply(): is the function that will be called when the OpenFlow Controller receives a flow_stats_reply message from the OpenFlow Switch. Here in our case, we update the flow statistics so that "decide_path()" can make the right decision.
    • send_flow_mod_add(): is the function that you should use to add a flow entry into an OpenFlow Switch.
    • decide_path(): is the function that makes path decisions. It returns the path choices based on flow statistics.
  • The Whole Process:
    • When the OpenFlow switch is ready, our controller starts a function that asks for flow stats once every 2 seconds.
    • The OpenFlow switch will reply with statistics information about all flows in its flow table.
    • This flow statistics message will be fetched by the "stats_reply" function in the OpenFlow controller implemented by the user on node "Switch".
    • As a result, our controller updates its knowledge about both left and right path once every 2 seconds.
    • Upon the arrival of a new TCP flow, the OpenFlow controller decides which path to send the new flow to, based on the updated flow statistics.

The FlowStatsReply message is in the following format:
  :length => 96,
  :table_id => 0,
  :match =>
  :duration_sec => 10,
  :duration_nsec => 106000000,
  :priority => 0,
  :idle_timeout => 0,
  :hard_timeout => 0,
  :cookie => 0xabcd,
  :packet_count => 1,
  :byte_count => 1,
  :actions => [ ]

C. About The Rspec file OpenFlowLBExo.rspec

  • The Rspec file describes a topology we showed earlier--each node is assigned with certain number of interfaces with pre-defined IP addresses
  • Some of the nodes are loaded with softwares and post-scripts. We will take node "Switch" as an example since it is the most complicated one.
    • The following section in the Rspec file for node "Switch":
        <install url="" 
      means it is going to download that tar ball from the specified URL and extract to directory "/"
    • The following section in the Rspec file for node "Switch":
        <execute shell="bash" command="/tmp/ $sliceName $self.Name() ; 
      names the post-boot script that ExoGENI is going to run for you after the nodes are booted.
  • More information about "/tmp/": It is a "hook" to the LabWiki interface. Experimenter run this so that LabWiki knows the name of the slice and the hostname of the particular node that OML/OMF toolkits are running on.
  • More information about "/tmp/of-topo-setup/lb-setup": "lb-setup" is to setup the load balancing switch. The source code as well as explanation is as follows:
    /tmp/of-topo-setup/prep-trema       # install all libraries for trema
    /tmp/of-topo-setup/ovs-start           # create ovs bridge
    cp /usr/bin/trace-oml2 /usr/bin/trace        # a hack to the current LabWiki --> needs to be fixed
    cp /usr/bin/nmetrics-oml2 /usr/bin/nmetrics       # a hack to the current LabWiki --> needs to be fixed
    # download the load balancing openflow controller source code to user directory
    wget -O /root/load-balancer.rb
    # wait until all interfaces are up, then fetch the mapping from interface name to its ip/MAC address and save this info in a file /tmp/ifmap
    # add port to the ovs bridge
    /tmp/of-topo-setup/find-interfaces $INTERFACES | while read iface; do
        ovs-vsctl add-port br0 $iface < /dev/null
    # create port map save it to /tmp/portmap
    ovs-ofctl show tcp: \
        | /tmp/of-topo-setup/ovs-id-ports \
        > /tmp/portmap

D. About the GIMI script you run on LabWiki

  • Line 1 to Line 128: the definition of oml trace and oml nmetrics library. It basically defines the command line options for oml2-trace and oml2-nmetrics, as well as the output (the monitoring data that is going to be stored into the oml server)
    • users are not supposed to modify them
    • the definition here we used is not the same as what is provided by the latest OML2 2.10.0 library because there is some version mis-match between the OMF that LabWiki is using and the OML2 toolkit that we are using. It is a temporary hack for now --> to be fixed
    • we added the definition of option "--oml-config" for trace app (Line 27-28) so that oml2-trace accepts configuration files:
      app.defProperty('config', 'config file to follow', '--oml-config',
                      :type => :string, :default => '"/tmp/monitor/conf.xml"')
  • Line 134 to Line 137: user defines the monitoring interfaces here. In our case, we want to monitor the interface on node "Switch" that connects to the left path (with IP and to the right path (with IP
  • Line 139 to Line 169: defines on which node the user wants to run which monitoring app; and the "display graph" option.
    • group "Monitor" monitors the left path statistics using nmetrics and trace.
    • group "Monitor1" monitors the right path statistics using nmetrics and trace.
    • To monitor the throughput information, we used oml2-trace with the option of "--oml-config" which uses the configuration file we created at /tmp/monitor/conf.xml, which simply sums up the number of tcp_packet_size (in Bytes) for each second and save the info into the OML Server (in a Postgre database):
      <omlc id="switch" encoding="binary">
        <collect url="" name="traffic">
          <stream mp="tcp" interval="1">
            <filter field="tcp_packet_size" operation="sum" rename="tcp_throughput" />
    • More information about nmetrics and trace can be found here:
  • Line 173 to Line 218: defines the experiment:
    • Line 175-177: starts the monitoring app
    • Line 179-181: starts the TCP receiver (using iperf)
    • Line 183-189: starts the load balancer and connects ovs switch to the load balancer (controller)
    • Line 191-200: starts 20 TCP flows, with 5 seconds interval between the initial of each Flow
    • Line 205-209: stop the load balancer controller, disconnect the ovs switch from the controller and finish the experiment
  • Line 217 to Line 234: defines the two graphs we want to plot:
    • The first uses the monitoring data from oml2-nmetrics to display the cumulated number of bytes observed from each of the interfaces;
    • The second graph uses the monitoring results from oml2-trace to display the throughput observed from each of the interfaces.

E. Tips: Debugging an OpenFlow Controller

You will find it helpful to know what is going on inside your OpenFlow controller and its associated switch when implementing these exercises.
This section contains a few tips that may help you out if you are using the Open vSwitch implementation provided with this tutorial. If you are using a hardware OpenFlow switch, your instructor can help you find equivalent commands.
The Open vSwitch installation provided by the RSpec included in this tutorial is located in /opt/openvswitch-1.6.1-F15. You will find Open vSwitch commands in /opt/openvswitch-1.6.1-F15/bin and /opt/openvswitch-1.6.1-F15/sbin. Some of these commands may be helpful to you. If you add these paths to your shell’s $PATH, you will be able to access their manual pages with man. Note that $PATH will not affect sudo, so you will still have to provide the absolute path to sudo; the absolute path is omitted from the following examples for clarity and formatting.

  • ovs-vsctl
    Open vSwitch switches are primarily configured using the ovs-vsctl command. For exploring, you may find the ovs-vsctl show command useful, as it dumps the status of all virtual switches on the local Open vSwitch instance. Once you have some information on the local switch configurations, ovs-vsctl provides a broad range of capabilities that you will likely find useful for expanding your network setup to more complex configurations for testing and verification. In particular, the subcommands add-br, add-port, and set-controller may be of interest.
  • ovs-ofctl
    The switch host configured by the given rspec listens for incoming OpenFlow connections on localhost port 6634. You can use this to query the switch state using the ovs-ofctl command. In particular, you may find the dump-tables and dump-flows subcommands useful. For example, sudo ovs-ofctl dump-flows tcp: will output lines that look like this:
    cookie=0x4, duration=6112.717s, table=0, n packets=1, n bytes=74, idle age=78,priority=5,tcp,
    nw src= actions=CONTROLLER:65535
    This indicates that any TCP segment with source IP in the subnet should be sent to the OpenFlow controller for processing, that it has been 78 seconds since such a segment was last seen, that one such segment has been seen so far, and the total number of bytes in packets matching this rule is 74. The other fields are perhaps interesting, but you will probably not need them for debugging. (Unless, of course, you choose to use multiple tables — an exercise in OpenFlow 1.1 functionality left to the reader.)
  • Unix utilities
    You will want to use a variety of Unix utilities, in addition to the tools listed in ExerciseLayout, to test your controllers. The standard ping and /usr/sbin/arping tools are useful for debugging connectivity (but make sure your controller passes ICMP ECHO REQUEST and REPLY packets and ARP traffic, respectively!), and the command netstat -an will show all active network connections on a Unix host; the TCP connections of interest in this exercise will be at the top of the listing. The format of netstat output is out of the scope of this tutorial, but information is available online and in the manual pages.
  • Linux netem
    Use the tc command to enable and configure delay and lossrate constraints on the outgoing interfaces for traffic traveling from the OpenFlow switch to the Aggregator node. To configure a path with a 20 ms delay and 10% lossrate on eth2, you would issue the command:
    sudo tc qdisc add dev eth2 root handle 1:0 netem delay 20ms loss 2%
    Use the "tc qdisc change" command to reconfigure existing links,instead of "tc qdisc add".