Changes between Version 7 and Version 8 of Internal/OpenFlow/miscOF

Timestamp:

Jun 6, 2013, 7:10:19 AM (12 years ago)

Author:

akoshibe

Comment:

—

Internal/OpenFlow/miscOF

@@ -3 +3 @@
 This page documents various odds-and-ends regarding !OpenFlow and related platforms, tools, and whatnot. 
 
- * Using xterm with mininet hosts. You can background then by doing:
-   {{{
-   mininet> h1 xterm &
-   }}}
-   this allows you to spawn a terminal for a switch, from which you can, say, sniff packets using wireshark. 
+==== mininet + xterm. ==== #mnxterm
+You can spawn and background terminals by doing:
+{{{
+mininet> h1 xterm &
+}}}
+this allows you to spawn a terminal for a switch, from which you can, say, sniff packets using `wireshark`. 
 
- * A good way to track packets and transactions between datapath and controller is via buffer Id for switch-initiated conversations, and by XID for controller-initiated transactions. A caveat is that the buffer ID is only applicable to a subset of messages e.g. !PacketIns and !PacketOuts. A -1 buffer ID indicates a controller-generated packet (e.g. by a flow pushing tool or via a REST API for static flows).  
+==== Tracking OF packets. ==== #trackof
+A good way to track packets and transactions between datapath and controller is via buffer Id for switch-initiated conversations, and by XID for controller-initiated transactions. A caveat is that the buffer ID is only applicable to a subset of messages e.g. !PacketIns and !PacketOuts. A -1 buffer ID indicates a controller-generated packet (e.g. by a flow pushing tool or via a REST API for static flows).  
 
- * making !FlowMods. If not building a match object from a !PacketIn, make sure to not forget to invert the wildcard bit for the field you are setting. The default match is wildcarded to all. For example, to make a match object that only inspects source MAC address of an Ethernet header:
-   {{{
-    (1)    OFMatch m1 = new OFMatch();
-    (2)    m1.setDataLayerSource(hwaddr);
-           m1.setWildcards(OFMatch.OFPFW_ALL & ~OFMatch.OFPFW_DL_SRC);
+====  openflowj !FlowMods. ==== #fm
+If not building a match object from a !PacketIn, make sure to not forget to invert the wildcard bit for the field you are setting. The default match is wildcarded to all. For example, to make a match object that only inspects source MAC address of an Ethernet header:
+{{{
+  (1)    OFMatch m1 = new OFMatch();
+  (2)    m1.setDataLayerSource(hwaddr);
+         m1.setWildcards(OFMatch.OFPFW_ALL & ~OFMatch.OFPFW_DL_SRC);
 
-    (3)    flowmod.setmatch(m1);   //and other params as necessary
-   }}}
-   1. Create a new match object. 
-   1. Add the source MAC address to match on, and turn the wildcard bit for source MAC field (OFPFW_DL_SRC)
-   1. set the !FlowMod match to the one you just created.  
+  (3)    flowmod.setmatch(m1);   //and other params as necessary
+}}}
+1. Create a new match object. 
+1. Add the source MAC address to match on, and turn the wildcard bit for source MAC field (OFPFW_DL_SRC)
+1. set the !FlowMod match to the one you just created.  
     
- * compiling oflops (cbench Controller Benchmarker). This requires an additional package, `libconfig8-dev`, in addition to the dependencies listed, so the list becomes:
-   {{{
-   autoconf automake libtool libsnmp-dev libpcap-dev libconfig8-dev
-   }}}
+==== oflops on Ubuntu. ==== #oflops
+Compiling `oflops` (cbench Controller Benchmarker) requires an additional package, `libconfig8-dev`, in addition to the dependencies listed, so the list becomes:
+{{{
+autoconf automake libtool libsnmp-dev libpcap-dev libconfig8-dev
+}}}
 
- * creating arbitrary protocol data in Floodlight Ethernet class. You need to 
-    1. Have a zero-argument constructor, and 
-    2. add your class and Ethertype to the etherTypeClassMap !HashMap
+More info on this tool can be found here: http://docs.projectfloodlight.org/display/floodlightcontroller/Cbench
+
+==== liboftrace - building and usage. ==== #oftrace
+This is an analyzer for .pcap format files i.e. a widely-used format for storing network traffic data used by analyzers such as `tcpdump` and `wireshark`. `liboftrace` includes two applications, ofstats and ofdump, as taken verbatim from [https://mailman.stanford.edu/pipermail/openflow-discuss/2009-April/000133.html a mailing list entry]: 
+
+ * ofstats: a program which calculates the controller processing delay, i.e., the difference in time between a packet_in message and the corresponding packet_out or flow_mod message.
+ * ofdump: a program that simply lists openflow message types with timestamps by switch/controller pair.
+  
+Its main page is here: http://www.openflowswitch.org/wk/index.php/Liboftrace [[BR]]
+You can get the source from a git repo: with `git clone git://github.com/capveg/oftrace.git` [[BR]]
+To build, you need `autoconf` and `libtool`. then it's the usual "./boot.sh;./configure;make;make install". [[BR]]
+    
+Both `ofstats` and `ofdump` follows the syntax: 
+{{{
+ofstats [pcap/file/location] [controller IP] [OF port]
+}}}
+At least `ofstats` will spew everything to stdout, so you might want to redirect it into a file. 
+
+
+==== openflowj and Ethernet payloads. ====   
+To create arbitrary protocol data in Floodlight Ethernet class, you need to 
+
+ 1. Have a zero-argument constructor, and 
+ 2. add your class and Ethertype to the etherTypeClassMap !HashMap
    
- the former is needed for the payload to be de-serialized properly, as class Ethernet calls getInstance() on the class being used as payload. The latter, or else it won't be parsed and casted properly. In addition point 2. implies that your class needs to implement IPacket. The best way to do this is by extending the provided abstract !BasePacket class.  
+The former is needed for the payload to be de-serialized properly, as class Ethernet calls getInstance() on the class being used as payload. The latter, or else it won't be parsed and casted properly. In addition point 2. implies that your class needs to implement IPacket. The best way to do this is by extending the provided abstract !BasePacket class.