Repository Structure

The MPQUIC-SBD repository contains the following source code structure:

1
2
3
4
5
6
7
8
9
10
11
12

mpquic-sbd/
├── log/                         # Where log files with experimental results are placed
├── network/mininet/             # Network scenarios for the mininet emulator
├── /src                         # Application implementation
|   └── AStream                  # AStream DASH player emulator (Python)
|   └── caddy                    # Caddy Web Server (Golang)
|   └── dash                     # Compiled files
|   └── quic-go                  # MPQUIC (Golang) extended to support SBD
├── Caddyfile                    # Caddy web server configuration file
├── background_sbd.py            # Python script to generate background traffic (D-ITG)
├── build.sh                     # Shell script to build the application (/src)
├── tcp_core.py                  # Python script to generate background traffic (bulk)

All source code files are designed to run on 64-bit Linux hosts.

Install, build, and run from a Vagrant VM

Following Steps 1, 2, and 3 below provides an easy way to run MPQUIC-SBD.

Step 1: Requirements

First, install Vagrant and VirtualBox on your host system.

1
2

cd ~
sudo apt-get install -y vagrant virtualbox

Install Vagrant and VirtualBox using your package manager, as shown in the commands above. Just for reference, the versions we used were:

  • Vagrant 2.0.2+dfsg-2ubuntu8
  • VirtualBox 5.2.42-dfsg-0~ubuntu1.18.04.1

Step 2: Build the Vagrant VM

To clone our repository and build the VM, run the following commands:

1
2
3
4

 cd ~
 git clone https://github.com/mpquic-sbd/mpquic-sbd-vagrant.git
 cd mpquic-sbd-vagrant
 sh setup.sh

Warning: Do not run sh setup.sh again, as it will run vagrant up and overwrite the built Vagrant VM.

Building: Using the Vagrant configuration file (VBox/Vagrantfile) provided below, the VM will be provisioned with 4GB of RAM and a 2-core CPU, with Ubuntu 18.04 LTS (Bionic Beaver) inside, which you can adjust as needed. Software packages will be automatically installed via the VBox/install.sh script. This ensures that the build process correctly installs Go 1.12, MPQUIC-SBD, the AStream Video Streaming Emulator, the Caddy Web Server, and Mininet.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

ENV['VAGRANT_DEFAULT_PROVIDER'] = 'virtualbox'

Vagrant.configure("2") do |config|
  config.vm.box = "ubuntu/bionic64"
  config.ssh.forward_agent = true
  config.ssh.forward_x11 = true

  config.vm.synced_folder "../Workspace", "/home/vagrant/Workspace"

  config.vm.provider "virtualbox" do |vb|
    # vb.gui = true
    vb.memory = "4096"  # in MB
    vb.cpus = "2"
  end

  config.vm.provision :shell, path: "install.sh", privileged: false
end

After building, the experimental setup is located in the mpquic-sbd-vagrant/Workspace directory of your running VM and follows this structure:

1
2
3

~/mpquic-sbd-vagrant
├── /Workspace
|   ├── /mpquic-sbd

Warning: If you ran setup.sh in Step 2, you already built everything using ./build.sh, then your Vagrant VM is all set.

Updated: