mptcp/mptcp-upstream-virtme-docker repository overview

⁠MPTCP Upstream Virtme Docker

This repo contains files to build a vitual environment with virtme to validate mptcp_net-next⁠ repo.

The idea here is to have automatic builds to published a docker that can be used by devs and CI.

⁠Entrypoint options

When launching the docker image, you have to specify the mode you want to use:

• manual-normal: This will compile a kernel without a debug config and leave you with a shell prompt.
• manual-debug: Same but with a kernel debug config.
• auto-normal: All the automatic tests are ran in a kernel without a debug config.
• auto-debug: Same but with a kernel debug config.
• auto-all: Same but both non-debug and debug config are used.
• make: run the make command with optional parameters.
• make.cross: run Intel's make.cross command with optional parameters.
• cmd: run the given command.
• src: source a given script file.
• help: display all possible commands.

All the manual-* and auto-* options accept optional arguments for scripts/config script from the kernel source code, e.g. -e DEBUG_LOCKDEP

⁠How to use

⁠User mode

Without cloning this repo, you can quickly get a ready to use environment:

cd <kernel source code>
docker pull mptcp/mptcp-upstream-virtme-docker:latest
docker run -v "${PWD}:${PWD}:rw" -w "${PWD}" --privileged --rm -it \
  mptcp/mptcp-upstream-virtme-docker:latest \
  <entrypoint options, see above>

This docker image needs to be executed with --privileged option to be able to execute QEmu with KVM acceleration.

⁠Developer mode

Clone this repo, then:

cd <kernel source code>
/PATH/TO/THIS/REPO/run-tests-dev.sh <entrypoint options, see above>

This will build and start the docker image.

⁠Extension

⁠Files

3 files can be created in the root dir of the kernel source code:

• .virtme-exec-pre
• .virtme-exec-run
• .virtme-exec-post

pre and post are ran before and after the tests suite. run is ran instead of the tests suite.

These scripts are sourced and can used functions from the virtme script.

⁠Env vars

⁠Not blocking with questions

You can set INPUT_NO_BLOCK=1 env var not to block if these files are present. This is useful if you need to do a git bisect.

⁠Packetdrill

You can set INPUT_PACKETDRILL_NO_SYNC=1 env var not to sync Packetdrill with upstream. This is useful if you mount a local packetdrill repo in the image.

You can also set INPUT_PACKETDRILL_NO_MORE_TOLERANCE=1 not to increase Packetdrill's tolerances.

If you run the Docker commands directly, you can use:

docker run \
  -e INPUT_PACKETDRILL_NO_SYNC=1 \
  -e INPUT_PACKETDRILL_NO_MORE_TOLERANCE=1 \
  -v /PATH/TO/packetdrill:/opt/packetdrill:rw \
  -v "${PWD}:${PWD}:rw" -w "${PWD}" \
  --privileged --rm -it \
  mptcp/mptcp-upstream-virtme-docker:latest \
  manual
cd /opt/packetdrill/gtests/net/
./packetdrill/run_all.py -lv mptcp/dss ## or any other subdirs
# or
cd /opt/packetdrill/gtests/net/mptcp/dss/ ## or any other subdirs
../../packetdrill/packetdrill -v dss_fin_server.pkt ## or any other tests

If you use the run*.sh scripts, you can set VIRTME_PACKETDRILL_PATH to do this mount and set the proper env var.

VIRTME_PACKETDRILL_PATH=/PATH/TO/packetdrill \
  /PATH/TO/THIS/REPO/run-tests-dev.sh <entrypoint options, see above>