packetdrill

This is the official Google release of packetdrill.

The packetdrill scripting tool enables quick, precise tests for entire TCP/UDP/IPv4/IPv6 network stacks, from the system call layer down to the NIC hardware. packetdrill currently works on Linux, FreeBSD, OpenBSD, and NetBSD. It can test network stack behavior over physical NICs on a LAN, or on a single machine using a tun virtual network device.

The code is GPLv2. Currently the source for the testing tool and a number of test scripts is in the git repository. We will continue to post more tests from our team's Linux TCP test suite (described in our USENIX paper), as time permits.

Links:

• the Google packetdrill git repository is now on github.com
• packetdrill USENIX ATC paper from June 2013 describing the tool and our team's experiences
• packetdrill USENIX ;login: article from October 2013
• packetdrill mailing list for questions, discussions and patches
• packetdrill language syntax reference

External links:

• using packetdrill for teaching TCP

How To Get Started with packetdrill

To check out and build packetdrill:

git clone https://github.com/google/packetdrill.git
cd packetdrill/gtests/net/packetdrill
./configure
make

If you are on a machine with a recent Linux kernel you can su to root and run all of the TCP stack tests included in the packetdrill distribution in the tcp/ directory:

cd ..
./packetdrill/run_all.py -S -v -L -l tcp/

How To Submit a Patch for packetdrill

We welcome patches with bug fixes or new features for packetdrill. The packetdrill project uses git for source code management. Please follow the following steps when sending in a patch for packetdrill:

1. join the packetdrill e-mail list, so your e-mails to the list will be accepted by Google groups
2. edit some files, compile, test
3. verify that you can certify the origin of this code with a Signed-off-by footer, according to the standards of the Linux open source project
4. git commit your change with a message like:

packetdrill: add amazing feature foo

This commit adds amazing feature foo, which ...

Tested on FooOS and BarOS by doing the following:
 ...

Signed-off-by: John Doe <[email protected]>

5. Generate git patches using: git format-patch HEAD~1
6. Check style for the patches by running checkpatch.pl from the Linux source tree, e.g.:

wget http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/scripts/checkpatch.pl
chmod u+x checkpatch.pl
./checkpatch.pl --no-tree --ignore FSF_MAILING_ADDRESS 00*.patch

7. You can submit your patch as either a GitHub pull request or an e-mail patch series, with something like:

git send-email --to [email protected] 00*.patch

MPTCP version

Code-style

The idea is to easily spot options, direction, by increasing spaces and aligning groups.

Code style for the packet traces:

• (minimum) 2 spaces between each section: times, syscalls, directions, flags, ACK, Win, options
• Align all syscalls together: two spaces after the larger time
• Align TCP flags (S, ., P, F, R)
• It's OK to align per block, e.g. align for the initiation of the connection but it can be different for the options during a transfer
• Spaces after commas in TCP options
• Blank lines between blocks

Guidelines

• Add load of comments: what the next block is doing and the reason
• No need to put a TCP window for outbound packets (except for 0) to allow env with different auto-tuning settings

find gtests/net/mptcp/ -name *pkt -exec sed -i -e 's/\(^\S\+\s\+>.*\) win [1-9][0-9]*/\1/' \{\} \;