Skip to content

Commit

Permalink
Final edits (#165)
Browse files Browse the repository at this point in the history
* Final instructions tidying

* Instructions

* Add final slides
  • Loading branch information
jnfoster authored Jun 6, 2018
1 parent 948a890 commit ac588a2
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 43 deletions.
Binary file added P4_tutorial.pdf
Binary file not shown.
Binary file removed P4_tutorial_labs.pdf
Binary file not shown.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,16 @@ you get started with P4 programming, organized into several modules:
* [Explicit Congestion Notification](./exercises/ecn)
* [Multi-Hop Route Inspection](./exercises/mri)

4. Advanced Data Structures
4. Advanced Behavior
* [Source Routing](./exercises/source_routing)
* [Calculator](./exercises/calc)

5. Dynamic Behavior
* [Load Balancing](./exercises/load_balance)

## Presentation

The slides are available [online](http://bit.ly/p4d2-2018-spring) and
in the P4_tutorial.pdf in the tutorial directory.

## Obtaining required software

If you are starting this tutorial at the Spring 2018 P4 Developer Day,
Expand Down
2 changes: 1 addition & 1 deletion exercises/ecn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ There are several ways that problems might manifest:
error emitted from the compiler and stop.
2. `ecn.p4` compiles but does not support the control plane rules in
the `sX-runtime.json` files that `make` tries to install using
the BMv2 CLI. In this case, `make` will log the CLI tool output
a Python controller. In this case, `make` will log the controller output
in the `logs` directory. Use these error messages to fix your `ecn.p4`
implementation.
3. `ecn.p4` compiles, and the control plane rules are installed, but
Expand Down
34 changes: 12 additions & 22 deletions exercises/load_balance/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ In this exercise, you will implement a form of load balancing based on
a simple version of Equal-Cost Multipath Forwarding. The switch you
will implement will use two tables to forward packets to one of two
destination hosts at random. The first table will use a hash function
(applied to a 5-tuple consisting of the source and destination
IP addresses, IP protocol, and source and destination TCP ports)
to select one of two hosts. The second table will use the
computed hash value to forward the packet to the selected host.
(applied to a 5-tuple consisting of the source and destination IP
addresses, IP protocol, and source and destination TCP ports) to
select one of two hosts. The second table will use the computed hash
value to forward the packet to the selected host.

> **Spoiler alert:** There is a reference solution in the `solution`
> sub-directory. Feel free to compare your implementation to the
Expand Down Expand Up @@ -63,16 +63,9 @@ control plane. When a rule matches a packet, its action is invoked
with parameters supplied by the control plane as part of the rule.

In this exercise, the control plane logic has already been
implemented. As part of bringing up the Mininet instance, the
`make` script will install packet-processing rules in the tables of
each switch. These are defined in the `s1-commands.txt` file.

**Important:** A P4 program also defines the interface between the
switch pipeline and control plane. The `s1-commands.txt` file contains
a list of commands for the BMv2 switch API. These commands refer to
specific tables, keys, and actions by name, and any changes in the P4
program that add or rename tables, keys, or actions will need to be
reflected in these command files.
implemented. As part of bringing up the Mininet instance, the `make`
script will install packet-processing rules in the tables of each
switch. These are defined in the `sX-runtime.json` files.

## Step 2: Implement Load Balancing

Expand Down Expand Up @@ -105,9 +98,6 @@ Follow the instructions from Step 1. This time, your message from
`h1` should be delivered to `h2` or `h3`. If you send several
messages, some should be received by each server.
### Food for thought
### Troubleshooting
There are several ways that problems might manifest:
Expand All @@ -116,10 +106,10 @@ There are several ways that problems might manifest:
report the error emitted from the compiler and stop.
2. `load_balance.p4` compiles but does not support the control plane
rules in the `sX-commands.txt` files that `make` tries to install
using the BMv2 CLI. In this case, `make` will log the CLI tool output
in the `logs` directory. Use these error messages to fix your `load_balance.p4`
implementation.
rules in the `sX-runtime.json` files that `make` tries to install
using the Python controller. In this case, `make` will log the
controller output in the `logs` directory. Use the error messages to
fix your `load_balance.p4` implementation.
3. `load_balance.p4` compiles, and the control plane rules are
installed, but the switch does not process packets in the desired way.
Expand All @@ -139,4 +129,4 @@ mn -c

## Next Steps

Congratulations, your implementation works!
Congratulations, your implementation works and you have finished the tutorial!
31 changes: 17 additions & 14 deletions exercises/mri/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,22 +210,26 @@ got a packet
There are several ways that problems might manifest:
1. `mri.p4` fails to compile. In this case, `make` will report the
error emitted from the compiler and stop.
error emitted from the compiler and stop.
2. `mri.p4` compiles but does not support the control plane rules in
the `sX-runtime.json` files that `make` tries to install using the BMv2 CLI.
In this case, `make` will log the CLI tool output in the `logs` directory.
Use these error messages to fix your `mri.p4` implementation.
the `sX-runtime.json` files that `make` tries to install using a
Python controller. In this case, `make` will log the controller
output in the `logs` directory. Use these error messages to fix
your `mri.p4` implementation.
3. `mri.p4` compiles, and the control plane rules are installed, 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
`build/<switch-name>-<interface-name>.pcap` also contains the pcap of
packets on each interface. Use `tcpdump -r <filename> -xxx` to print
the hexdump of the packets.
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 `build/<switch-name>-<interface-name>.pcap` also contains the
pcap of packets on each interface. Use `tcpdump -r <filename> -xxx`
to print the hexdump of the packets.
4. `mri.p4` compiles and all rules are installed. Packets go through
and the logs show that the queue length is always 0. Then either
reduce the link bandwidth in `topology.json`.
and the logs show that the queue length is always 0. Then either
reduce the link bandwidth in `topology.json`.
#### Cleaning up Mininet
Expand All @@ -241,4 +245,3 @@ make stop
Congratulations, your implementation works! Move on to [Source
Routing](../source_routing).
6 changes: 3 additions & 3 deletions exercises/source_routing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ 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. Note that the last hop can
also revert back the etherType to `TYPE_IPV4`.
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
Expand Down Expand Up @@ -72,7 +72,7 @@ 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
pieces of logic replaced by `TODO` comments. These should guide your
implementation---replace each `TODO` with logic implementing the
missing piece.

Expand Down

0 comments on commit ac588a2

Please sign in to comment.