[#39] Cleans up environment

.gitattributes

@@ -1 +1,3 @@
 bin/bpftool filter=lfs diff=lfs merge=lfs -text
+*.svg filter=lfs diff=lfs merge=lfs -text
+

CMakeLists.txt

@@ -71,8 +71,8 @@ write_basic_package_version_file(
  "${version_config}" COMPATIBILITY SameMajorVersion
 )
 
-# set(INCLUDE_INSTALL_DIR include/)
-# set(LIB_INSTALL_DIR lib/ )
+set(INCLUDE_INSTALL_DIR include/)
+set(LIB_INSTALL_DIR lib/ )
 # Configure '<PROJECT-NAME>Config.cmake'
 # Use variables:
 # * TARGETS_EXPORT_NAME

Makefile

@@ -85,16 +85,16 @@ run-redirect-map-sample: all ## Build all and run BPF XDP redirect sample
 run-control-plane-tests: force-xdp-deload ## Run ControlPlaneTests
  ./tests/scripts/run_test ControlPlaneTests
 
-run-session-manager-tests: force-xdp-deload ## Run SessionManagerTests
- sudo bash ./tests/scripts/run_test UPFProgramTests
+run-session-manager-tests: force-xdp-deload ## Run SessionManagerTests 
+ sudo -E bash ./tests/scripts/run_test UPFProgramTests
 
 rerun: force-xdp-deload run ## Build all and run BPF XDP UPF
 
 dut-run: ## Run ControlPlaneTests on DUT
  sudo ./bin/ControlPlaneTests
 
 force-xdp-deload: ## Kill all and force deload XDP programs
- sudo bash tests/scripts/force_xdp_deload
+ sudo -E bash tests/scripts/force_xdp_deload
 
 trex: ## Install, deploy configuration and run t-rex on remote server
  tests/scripts/install_trex_remote
@@ -114,6 +114,9 @@ tmux: ## Create a test session using tmux
 docker-build: ## Build development image
  docker/build_docker
 
+docker-build-ubuntu-18.04: ## Build development image
+ docker/build_docker ubuntu:18.04
+
 docker-run: ## Run development container
  docker/run_docker
 

README.md

@@ -1,9 +1,20 @@
-User plane function using BPF and XDP for mobile core network (4G/5G).
+# Telco User Plane using eBPF/XDP
+
+An open source C++ library powered by eBPF/XDP for user plane in mobile core network (LTE/5G).
+
+This project is based on the following 3GPP Technical Specification:
+- LTE; 5G; Interface between the Control Plane and the User Plane nodes (3GPP TS 29.244 version 16.5.0 Release 16) 
+- 5G; System architecture for the 5G System (5GS) (3GPP TS 23.501 version 16.5.0 Release 16)
+
+<p align="center">
+ <img src="img/UPeBPF-design.svg" alt="drawing" width="400" class="center"/>
+</p>
 
 ## Usage
 ### Build Docker Image
 
 Copy the keys to jump server and run `make docker-build`
+
 ### Testing
 
 ![setup-for-GPDU-debug-issue-2-upf-bpf](https://user-images.githubusercontent.com/42647168/86470179-4486cc80-bd11-11ea-8f55-fee848b12e11.png)

docker/Dockerfile

@@ -1,4 +1,5 @@
-FROM ubuntu:20.04
+ARG BASE_DEV_IMAGE=ubuntu:20.04
+FROM $BASE_DEV_IMAGE
 
 ARG UNAME=oai-spgwu
 WORKDIR /tmp/$UNAME
@@ -72,12 +73,11 @@ RUN apt-get update && \
  apt-get install -y \
  tmux
 
-# It is comment due to ubuntu 20.04 base image.
-# If you use another one, uncomment the lines below.
-# RUN apt-get update && \
-# apt-get -y install libssl-dev && \
-# wget -c https://github.com/Kitware/CMake/releases/download/v3.19.2/cmake-3.19.2.tar.gz -O - | tar -xz && \
-# cd cmake-3.19.2 && ./bootstrap && make && make install
+# Ubuntu 20.04 already support cmake 3.19.
+RUN if [ $BASE_DEV_IMAGE != "ubuntu:20.04" ]; then apt-get update && \
+ apt-get -y install libssl-dev && \
+ wget -c https://github.com/Kitware/CMake/releases/download/v3.19.2/cmake-3.19.2.tar.gz -O - | tar -xz && \
+ cd cmake-3.19.2 && ./bootstrap && make -j4 && make install; fi
 
 # Add your local bashrc
 ADD .bashrc /home/$USERNAME/
@@ -141,17 +141,16 @@ RUN apt-get update && \
 
 RUN pip3 install ipykernel
 RUN pip3 install matplotlib
-RUN pip3 install paramiko
 RUN pip3 install autopep8
 
 RUN apt-get update && \
  apt-get install -y \
  rsync
 
-ARG ENV_FILENAME="env.sh"
-ADD ${ENV_FILENAME} ${ENV_FILENAME}
+# TODO: pass as ARG
+RUN echo "ENV_FILE=/workspaces/env.sh" >> /etc/environment
 
 # Omit if you want to keep the default as root.
 # USER $USERNAME
 
-CMD ${ENV_FILENAME} && /bin/bash
+CMD /bin/bash

docker/build_docker

@@ -9,6 +9,9 @@ main() {
  local -r context="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  source "${context}"/../env.sh
  local env_file_name=env.sh
+ local base_dev_image="${1-ubuntu:20.04}"
+
+ echo "Base image "${base_dev_image}""
 
  # Copy configuration files and ssh keys to the docker context folder.
  cp "${GIT_CONFIG}" "${context}"
@@ -20,13 +23,14 @@ main() {
  cp "${context}"/../env.sh "${context}"
 
  # Build dockerfile.
- docker build --tag="${IMAGE}":"${VERSION}" --rm -f "${context}"/"${DOCKERFILE}" "${context}" \
+ docker build --tag="${IMAGE_TAG}":"${IMAGE_VERSION}" --rm -f "${context}"/"${DOCKERFILE}" "${context}" \
  --build-arg ENV_FILENAME="${env_file_name}" \
  --build-arg DUT_SERVER_IP="${DUT_IP}" \
  --build-arg TREX_SERVER_IP="${TREX_SERVER_IP}" \
  --build-arg JUMP_SERVER_USERNAME="${JUMP_SERVER_USERNAME}" \
  --build-arg JUMP_SERVER_IP="${JUMP_SERVER_IP}" \
- --build-arg JUMP_SERVER_PORT="${JUMP_SERVER_PORT}"
+ --build-arg JUMP_SERVER_PORT="${JUMP_SERVER_PORT}" \
+ --build-arg BASE_DEV_IMAGE="${base_dev_image}"
 
  # Remove configuration files and ssh keys from the docker context folder.
  rm "${context}"/.gitconfig
@@ -35,6 +39,10 @@ main() {
  rm "${context}"/"${SSH_CONFIG_FILE}"
  rm "${context}"/.bashrc
  rm "${context}"/env.sh
+
+ echo
+ echo "Image "${IMAGE_TAG}" was build with base image "${base_dev_image}""
+ echo 
 }
 
 main "$@"

docker/run_docker

@@ -12,7 +12,7 @@ main() {
  --env-file "${dirname}"/../env.sh \
  --volume "${dirname}"/../:"${WORKSPACE}" \
  --privileged \
- --workdir "${WORKSPACE}" "${IMAGE}":"${VERSION}" \
+ --workdir "${WORKSPACE}" "${IMAGE_TAG}":"${IMAGE_VERSION}" \
  /bin/bash
 
  exit 0

env.sh

@@ -9,8 +9,8 @@ NUM_THREADS=4
 
 # Docker environment variable.
 USERNAME=oai-spgwu
-IMAGE=upee
-VERSION=v1.0
+IMAGE_TAG=upee
+IMAGE_VERSION=v1.0
 DOCKERFILE=Dockerfile
 SSH_FOLDER=~/.ssh
 SSH_PUBLIC_KEY_FILE=id_rsa.pub
@@ -91,4 +91,4 @@ API_HTTP_PORT=80
 # Programs name
 API_PROGRAM_NAME=api
 
-PYTHONPATH=/workspaces/tests/trex/trex_client/interactive/
+PYTHONPATH=/workspaces/tests/trex/trex_client/interactive/

src/CMakeLists.txt

@@ -64,8 +64,8 @@ install(
 
 # Headers:
 # * ./*.h -> <prefix>/include/*.h
-# install(
-#  DIRECTORY "./"
-#  DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
-#  FILES_MATCHING PATTERN "*.h"
-# )
+install(
+ DIRECTORY "./"
+ DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
+ FILES_MATCHING PATTERN "*.h"
+)

src/programs/ProgramLifeCycle.hpp

@@ -108,8 +108,10 @@ ProgramLifeCycle<BPFSkeletonType>::ProgramLifeCycle(std::function<BPFSkeletonTyp
  , mLoadFunc(loadFunc)
  , mAttachFunc(attachFunc)
  , mDestroyFunc(destroyFunc)
+ , mpSkeleton(NULL)
 {
  LOG_FUNC();
+ // Check if the XDP is driver or skb mode.
  mFlags = Configuration::sIsSocketBufferEnabled ? XDP_FLAGS_UPDATE_IF_NOEXIST | XDP_FLAGS_SKB_MODE : XDP_FLAGS_UPDATE_IF_NOEXIST;
 }
 

src/programs/UPFProgram.cpp

@@ -34,7 +34,9 @@ void UPFProgram::setup()
  throw std::runtime_error("GTP or UDP interface not defined!");
  }
 
+ LOG_DBG("Link UDP interface to interface {}", mUDPInterface.c_str())
  mpLifeCycle->link("xdp_entry_point", mUDPInterface.c_str());
+ LOG_DBG("Link GTP interface to interface {}", mGTPInterface.c_str())
  mpLifeCycle->link("xdp_entry_point", mGTPInterface.c_str());
 
 }

tests/scripts/config_veth_pair

@@ -12,7 +12,7 @@ create_namespace() {
  local -r filename="${dirname}/$(basename "${BASH_SOURCE[0]}")"
 
  # TODO navarrothiago - check if it is recommend to call env.sh here.
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  local nr_cpu=$(nproc)
  local namespace=$1

tests/scripts/deploy_package

@@ -11,7 +11,7 @@ main() {
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
  local -r filename="${dirname}/$(basename "${BASH_SOURCE[0]}")"
 
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  echo
  echo "Copy package with binary and libraries."

tests/scripts/deploy_trex_config

@@ -10,7 +10,7 @@ main() {
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  scp -r "${LOCAL_CONFIG_DIR}" "${TREX_SERVER_SSH}":"${TREX_SERVER_UPLOAD_DIR}"
  scp -r "${LOCAL_TRAFFIC_DIR}" "${TREX_SERVER_SSH}":"${TREX_SERVER_UPLOAD_DIR}"

tests/scripts/force_xdp_deload

@@ -7,7 +7,7 @@ main() {
  set -o nounset
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
  local gtp_interface=${1:-veth0}
  local udp_interface=${2:-veth1}
 

tests/scripts/install_trex_remote

@@ -11,7 +11,7 @@ main() {
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  # Execute local script (install_trex) on the server.
 

tests/scripts/run_sample

@@ -6,7 +6,7 @@ main() {
  set -o nounset
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  local sample_binary_name=$1
 

tests/scripts/run_test

@@ -5,7 +5,7 @@ main() {
  set -o pipefail
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  local test_binary=$1
  local gtp_interface=${2:-veth0}

tests/scripts/run_trex_server

@@ -10,7 +10,7 @@ main() {
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  echo
  echo "Run t-rex server on "${TREX_SERVER_IP}"."

tests/scripts/run_trex_test_case

@@ -9,7 +9,7 @@ main() {
  set -o nounset
 
  local -r dirname="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
  local test_case_file="${1}".py
  local run_trex_client_command="export PYTHONPATH='"${TREX_CLIENT_LIB_DIR}"'; python3 "${REMOTE_TEST_CASES_DIR}"/""${test_case_file}"
 

tests/scripts/start_session

@@ -78,7 +78,7 @@ main() {
  local -r filename="${dirname}/$(basename "${BASH_SOURCE[0]}")"
  local -r session_name="upee"
 
- source "${dirname}"/../../env.sh
+ source "${ENV_FILE}"
 
  # if [[ $# != 4 ]]; then
  # echo >&2 "TODO!! "