* First draft of Ubuntu 20.04 Vagrantfile and scripts to install 2021-Mar version of open source P4 development tools. * Add more tracing output of what files have been installed at each step * Don't do behavioral-model install_deps.sh before installing PI This is an experiment to see if the end result will be able to run tutorials basic exercise using Python3 only on an Ubuntu 20.04 system. Just before this commit, `vagrant up` resulted in a system that failed to run the basic exercise, because python3 failed to import google.grpc (if I recall correctly -- it may have been a different google.<something> Python3 module name). * Add missing patch file * Fix copy and paste mistake * Add missing patch file * Change how protobuf Python3 module files are installed * Correct a few desktop icon file names, and add clean.sh script * Enhance clean.sh script, and add README for manual steps in creating a VM * Changes to try to always use Python3, never Python2, in tutorials * Update README steps for preparing a VM * More additions to README on steps to create a single file VM image * Add empty-disk-block zeroing to clean.sh script * Also install PTF * Update versions of P4 dev tool source code to 2021-Apr-05 This includes a change to p4lang/PI that allows P4Runtime API clients to send the shortest byte sequences necessary to encode integer values, which I want for a PTF test that I have recently created. * Update README for 2021-Apr-05 version of VM image * Resolve Python 3 compatibility issues Most of the Python 2 to 3 code translation changes were automated with the 2to3 tool. Signed-off-by: Radostin Stoyanov <rstoyanov@fedoraproject.org> * Update commit SHAs for 4 p4lang repos to latest as of 2021-May-04 * Update Ubuntu 20.04 README.md for how I created 2021-May-04 version of VM * mycontroller: Use Python 3 shebang line Signed-off-by: Radostin Stoyanov <rstoyanov@fedoraproject.org> * Update Ubuntu 20.04 README.md for how I created 2021-Jun-01 version of VM * Update commit SHAs for 4 p4lang repos to latest as of 2021-Jul-07 * Update Ubuntu 20.04 README.md for how I created 2021-Jul-07 version of VM * Update commit SHAs for 4 p4lang repos to latest as of 2021-Aug-01 * Update Ubuntu 20.04 README.md for how I created 2021-Aug-01 version of VM * Update commit SHAs for 4 p4lang repos to latest as of 2021-Sep-07 * Update Ubuntu 20.04 README.md for how I created 2021-Sep-07 version of VM Co-authored-by: Radostin Stoyanov <rstoyanov@fedoraproject.org>
Implementing Source Routing
Introduction
The objective of this exercise is to implement source routing. With source routing, the source host guides each switch in the network to send the packet to a specific port. The host puts a stack of output ports in the packet. In this example, we just put the stack after Ethernet header and select a special etherType to indicate that. Each switch pops an item from the stack and forwards the packet according to the specified port number.
Your switch must parse the source routing stack. Each item has a bos
(bottom of stack) bit and a port number. The bos bit is 1 only for the
last entry of stack. Then at ingress, it should pop an entry from the
stack and set the egress port accordingly. The last hop may also
revert back the etherType to TYPE_IPV4
.
Spoiler alert: There is a reference solution in the
solution
sub-directory. Feel free to compare your implementation to the reference.
Step 1: Run the (incomplete) starter code
The directory with this README also contains a skeleton P4 program,
source_routing.p4
, which initially drops all packets. Your job (in
the next step) will be to extend it to properly to route packets.
Before that, let's compile the incomplete source_routing.p4
and
bring up a network in Mininet to test its behavior.
-
In your shell, run:
make
This will:
- compile
source_routing.p4
, and - start a Mininet instance with three switches (
s1
,s2
,s3
) configured in a triangle, each connected to one host (h1
,h2
,h3
). Check the network topology using thenet
command in mininet. You can also change the topology in topology.json - The hosts are assigned IPs of
10.0.1.1
,10.0.2.2
, etc (10.0.<Switchid>.<hostID>
).
- compile
-
You should now see a Mininet command prompt. Open two terminals for
h1
andh2
, respectively:mininet> xterm h1 h2
-
Each host includes a small Python-based messaging client and server. In
h2
's xterm, start the server:./receive.py
-
In
h1
's xterm, send a message from the client:./send.py 10.0.2.2
-
Type a list of port numbers. say
2 3 2 2 1
. This should send the packet throughh1
,s1
,s2
,s3
,s1
,s2
, andh2
. However,h2
will not receive the message. -
Type
q
to exit send.py and typeexit
to leave each xterm and the Mininet command line.
The message was not received because each switch is programmed with
source_routing.p4
, which drops all packets on arrival. You can
verify this by looking at /tmp/p4s.s1.log
. Your job is to extend
the P4 code so packets are delivered to their destination.
Step 2: Implement source routing
The source_routing.p4
file contains a skeleton P4 program with key
pieces of logic replaced by TODO
comments. These should guide your
implementation---replace each TODO
with logic implementing the
missing piece.
A complete source_routing.p4
will contain the following components:
- Header type definitions for Ethernet (
ethernet_t
) and IPv4 (ipv4_t
) and Source Route (srcRoute_t
). - TODO: Parsers for Ethernet and Source Route that populate
ethernet
andsrcRoutes
fields. - An action to drop a packet, using
mark_to_drop()
. - TODO: An action (called
srcRoute_nhop
), which will:- Set the egress port for the next hop.
- remove the first entry of srcRoutes
- A control with an
apply
block that:- checks the existence of source routes.
- TODO: if statement to change etherent.etherType if it is the last hop
- TODO: call srcRoute_nhop action
- A deparser that selects the order in which fields inserted into the outgoing packet.
- A
package
instantiation supplied with the parser, control, and deparser.In general, a package also requires instances of checksum verification and recomputation controls. These are not necessary for this tutorial and are replaced with instantiations of empty controls.
Step 3: Run your solution
Follow the instructions from Step 1. This time, your message from h1
should be delivered to h2
.
Check the ttl
of the IP header. Each hop decrements ttl
. The port
sequence 2 3 2 2 1
, forces the packet to have a loop, so the ttl
should be 59 at h2
. Can you find the port sequence for the shortest
path?
Food for thought
- Can we change the program to handle both IPv4 forwarding and source routing at the same time?
- How would you enhance your program to let the first switch add the path, so that source routing would be transparent to end-hosts?
Troubleshooting
There are several ways that problems might manifest:
source_routing.p4
fails to compile. In this case,make
will report the error emitted from the compiler and stop.source_routing.p4
compiles but switches or mininet do not start. Do you have another instance of mininet running? Did the previous run of mininet crash? if yes, check "Cleaning up Mininet" bellow.source_routing.p4
compiles but the switch does not process packets in the desired way. The/tmp/p4s.<switch-name>.log
files contain trace messages describing how each switch processes each packet. The output is detailed and can help pinpoint logic errors in your implementation. The<switch-name>-<interface-name>_<direction>.pcap
files contain pcap captures of all packets sent and received on each interface. Usetcpdump -r <filename> -xxx
to print the hexdump of the packets.
Cleaning up Mininet
In the cases above, make
may leave a Mininet instance running in
the background. Use the following command to clean up these
instances:
mn -c
Next Steps
Congratulations, your implementation works! Move on to Load Balance.