OpenAirInterface

https://gitlab.eurecom.fr/oai/openairinterface5G/-/blob/develop/doc
Admin
OpenAirInterface is an open-source 5G and 4G radio access network implementation supporting both gNB...
Tokens:237,610
Snippets:2,597
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Runtime Environment Setup

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.gNB.aerial.ubuntu.sanitize-address?ref_type=heads

Sets up the runtime environment for the OpenAirInterface gNB, installing necessary runtime packages and libraries.

```dockerfile
#start from scratch for target executable
FROM ${UBUNTU_IMAGE} AS oai-gnb-aerial
ENV DEBIAN_FRONTEND=noninteractive
ENV TZ=Europe

RUN apt-get update && \
    apt-get upgrade --yes && \
    apt-get install --yes \
        software-properties-common \
        procps \
        libsctp1 \
        tzdata \
        libconfig9 \
        openssl \
        net-tools \
        iperf \
        iproute2 \
        iputils-ping \
        gdb \
        moreutils \
        libusb-1.0-0 \
        libyaml-cpp-dev && \
    rm -rf /var/lib/apt/lists/*

WORKDIR /opt/oai-gnb/bin
COPY --from=ran-build \
    /oai-ran/cmake_targets/ran_build/build/nr-softmodem ./
```

--------------------------------

### Install Git, Net-Tools, and Putty

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_OAI_CN5G.md

Installs essential networking and system utilities required for the OAI CN5G setup. This command should be run on an Ubuntu 24.04 LTS system.

```bash
sudo apt install -y git net-tools putty
```

--------------------------------

### Start Source gNB (gNB-PCI0)

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/handover-tutorial.md?ref_type=heads

Launches the source gNB instance with specified configuration, enabling telnet support and RF simulation. Ensure the configuration file path and parameters are correct for your setup.

```bash
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.pci0.rfsim.conf --telnetsrv --telnetsrv.shrmod ci --gNBs.[0].min_rxtxtime 6 --rfsim --rfsimulator.[0].serveraddr 127.0.0.1
```

--------------------------------

### Execute UE Softmodem and Verify Interfaces

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/L2NFAPI_S1.md?ref_type=heads

Example workflow for starting the softmodem and checking the resulting oaitun_ue tunnel interfaces.

```bash
$ ssh sudousername@machineC
cd ue_folder/cmake_targets
sudo -E ./ran_build/build/lte-uesoftmodem -O ../ci-scripts/conf_files/nrue.uicc.conf --L2-emul 3 --num-ues 64 --nums_ue_thread 1 > ue.log 2>&1
sleep 10
ifconfig
ens3      Link encap:Ethernet  HWaddr XX:XX:XX:XX:XX:XX
          inet addr:192.168.122.169  Bcast:192.168.122.255  Mask:255.255.255.0
....
oaitun_ue1 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:192.172.0.2  P-t-P:192.172.0.2  Mask:255.255.255.0
....
oaitun_ue2 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:192.172.0.3  P-t-P:192.172.0.3  Mask:255.255.255.0
....
oaitun_ue3 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:192.172.0.4  P-t-P:192.172.0.4  Mask:255.255.255.0
....
oaitun_ue4 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:192.172.0.5  P-t-P:192.172.0.5  Mask:255.255.255.0
....
oaitun_uem1 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:10.0.2.2  P-t-P:10.0.2.2  Mask:255.255.255.0
....
....
```

--------------------------------

### Start UE

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/L2NFAPI_S1.md?ref_type=heads

Navigate to the UE build directory on machine C and prepare to start the UE. The specific command to start the UE is not provided in this snippet.

```bash
$ ssh sudousername@machineC
cd ue_folder/cmake_targets

```

--------------------------------

### Start OAI gNB with Configuration

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Use this command to start the OAI gNB. Ensure the configuration file path and thread pool arguments are adapted to your system's setup, especially regarding isolated and non-isolated CPU cores.

```bash
cd ~/openairinterface5g/cmake_targets/ran_build/build
sudo ./nr-softmodem -O <configuration file> --thread-pool <list of non isolated cpus>
```

--------------------------------

### Start eNB with Configuration

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/L2NFAPI_NOS1.md?ref_type=heads

Execute the command to start the eNB using the specified configuration file. Redirect output to a log file for monitoring. Verify network interfaces after starting.

```bash
$ ssh sudousername@machineB
cd enb_folder/cmake_targets
sudo -E ./ran_build/build/lte-softmodem -O ../ci-scripts/conf_files/rcc.band7.tm1.nfapi.conf --noS1 > enb.log 2>&1
sleep 10
ifconfig
ens3      Link encap:Ethernet  HWaddr XX:XX:XX:XX:XX:XX
          inet addr:192.168.122.31  Bcast:192.168.122.255  Mask:255.255.255.0
....
oaitun_enb1 Link encap:UNSPEC  HWaddr 00-00-00-00-00-00-00-00-00-00-00-00-00-00-00-00
          inet addr:10.0.1.1  P-t-P:192.172.0.2  Mask:255.255.255.0
....

```

--------------------------------

### Compile and Install DPDK

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Compiles and installs DPDK using Meson and Ninja build systems. Ensure Meson is installed first.

```bash
# Installing meson : it should pull ninja-build and compiler packages
# on debian
sudo apt install meson
# on Fedora/RHEL
sudo dnf install meson
tar xvf dpdk-20.11.9.tar.xz && cd dpdk-stable-20.11.9

meson build
ninja -C build
sudo ninja install -C build
```

--------------------------------

### Start Aerial gNB Setup with Docker Compose

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/Aerial_FAPI_Split_Tutorial.md?ref_type=heads

Navigate to the specified directory and run this command to start the gNB and associated containers. The nv-cubb container starts first, followed by oai-gnb-aerial.

```bash
cd ci-scripts/yaml_files/sa_gnb_aerial/
docker compose up -d
```

--------------------------------

### Start OAI UE with RF Simulator

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/handover-tutorial.md

Launch the OAI User Equipment (UE) and configure it to act as the RF simulator server. This setup is crucial for allowing the UE to connect to multiple DUs.

```bash
sudo ./nr-uesoftmodem -C 3450720000 -r 106 --numerology 1 --ssb 516 -O <config>  --rfsim --rfsimulator.[0].serveraddr server
```

--------------------------------

### Install Git

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/GET_SOURCES.md

Install the Git client on Debian/Ubuntu-based systems using apt-get. This is a prerequisite for cloning the OpenAirInterface5G repository.

```bash
sudo apt-get update
sudo apt-get install git
```

--------------------------------

### Install DPDK to Custom Directory

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/LDPC_OFFLOAD_SETUP.md

Build and install DPDK to a non-default installation prefix using Meson. Ensure to run ldconfig after installation.

```bash
cd ~/dpdk-stable
# meson setup build
meson setup --prefix=/opt/dpdk-t2 build # for installation with non-default installation prefix
cd build
ninja
sudo ninja install
sudo ldconfig
```

--------------------------------

### Build and Install XDMA Driver

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/LDPC_XDMA_offload_setup.md

Compile and install the XDMA driver. The `sudo make install` command ensures the driver loads automatically at system startup.

```bash
cd ~/dma_ip_drivers/XDMA/linux-kernel/xdma
make clean
make
# install to make the driver loading automatically at system startup
sudo make install
```

--------------------------------

### Install OAI CN5G Prerequisites

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_OAI_CN5G.md?ref_type=heads

Install necessary system packages and Docker engine on Ubuntu 24.04.

```bash
sudo apt install -y git net-tools putty

# https://docs.docker.com/engine/install/ubuntu/
sudo apt update
sudo apt install -y ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

# Add your username to the docker group, otherwise you will have to run in sudo mode.
sudo usermod -a -G docker $(whoami)
reboot
```

--------------------------------

### Start eNB

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/L2NFAPI_S1.md?ref_type=heads

Start the eNB (evolved NodeB) on machine B. Use the specified command with the configuration file and redirect output to 'enb.log'.

```bash
$ ssh sudousername@machineB
cd enb_folder/cmake_targets
sudo -E ./ran_build/build/lte-softmodem -O ../ci-scripts/conf_files/rcc.band7.tm1.nfapi.conf > enb.log 2>&1
```

--------------------------------

### Install Dependencies via PPA (Ubuntu)

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/BUILD.md

Installs prerequisites, including the UHD driver, from the Ettus PPA for Ubuntu systems. This is the default method if not installing UHD from source.

```bash
./build_oai -I -w USRP
```

--------------------------------

### Setup Hugepages

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/LDPC_OFFLOAD_SETUP.md

Configure hugepages on the system. This example sets up 16GB of 1GB hugepages. Ensure sufficient allocation.

```bash
# sudo dpdk-hugepages.py -p 1G --setup 16G
```

--------------------------------

### Build Additional Libraries

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/BUILD.md

Example of enabling specific build options like telnetsrv and building the target directly.

```bash
cmake .. -GNinja -DENABLE_TELNETSRV=ON
ninja telnetsrv
```

--------------------------------

### Configure 4x4 RANK 2 for PHY Test

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/UL_MIMO.md

This command configures the gNB and UE for a 4x4 MIMO setup with rank 2. It's similar to the RANK 4 example but adjusts the uplink number of layers.

```bash
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.4layer.conf --rfsim --phy-test --l 2  --L 2
```

```bash
sudo ./nr-uesoftmodem  --rfsim --phy-test --ue-nb-ant-rx 4 --ue-nb-ant-tx 4
```

--------------------------------

### Start OAI gNB and UE Components

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/handover-tutorial.md

Commands to initialize the source gNB, target gNB, and the UE for the handover scenario.

```bash
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.pci0.rfsim.conf --telnetsrv --telnetsrv.shrmod ci --gNBs.[0].min_rxtxtime 6 --rfsim --rfsimulator.[0].serveraddr 127.0.0.1
```

```bash
sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --rfsim --uicc0.imsi 001010000000001 -O ../../../ci-scripts/conf_files/nrue.uicc.conf --rfsimulator.[0].serveraddr server
```

```bash
sudo ./nr-softmodem -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.pci1.rfsim.conf --rfsim --telnetsrv --telnetsrv.shrmod ci --gNBs.[0].min_rxtxtime 6 --rfsimulator.[0].serveraddr 127.0.0.1
```

--------------------------------

### gNB DU Configuration for One RU (M-Plane)

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Example configuration for a gNB DU with one RU using M-plane. Adjust `dpdk_devices`, `du_addr`, and `vlan_tag` based on your setup. Ensure `du_key_pair` points to valid SSH keys.

```lua
fhi_72 = {
  dpdk_devices = ("0000:c3:11.0", "0000:c3:11.1"); # one VF can be used as well
  system_core = 0;
  io_core = 1;
  worker_cores = (2);
  du_key_pair = ("<path-to>/.ssh/id_rsa.pub", "<path-to>/.ssh/id_rsa");
  du_addr = ("00:11:22:33:44:66", "00:11:22:33:44:67"); # only one needed if one VF configured
  vlan_tag = (9, 9); # only one needed if one VF configured
  ru_username = ("oranbenetel");
  ru_ip_addr = ("192.168.80.9");
  fh_config = ({
    T1a_cp_dl = (419, 470);
    T1a_cp_ul = (285, 336);
    T1a_up = (294, 345);
    Ta4 = (0, 200);
  });
};

```

--------------------------------

### Copy Utility and Entrypoint

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.gNB.rhel9?ref_type=heads

Copies the 'yq' utility and the 'tini' init system from the 'gnb-base' stage to /usr/local/bin/ and /tini respectively.

```dockerfile
WORKDIR /opt/oai-gnb
COPY --from=gnb-base /usr/local/bin/yq /usr/local/bin/yq
COPY --from=gnb-base /tini /tini
```

--------------------------------

### Copy Build Configuration and Execute Build

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.base.ubuntu.cross-arm64?ref_type=heads

Copies the main build configuration file and then executes the build script to create the OpenAirInterface5G image. This includes setting the working directory, copying the environment file, sourcing it, and running the build command with the '-I' flag.

```bash
WORKDIR /oai-ran
COPY oaienv .

#run build_oai -I to get the builder image
RUN /bin/sh oaienv && \
    cd cmake_targets && \
    mkdir -p log && \
    ./build_oai -I && \
    apt-get clean
```

--------------------------------

### Start EPC

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/L2NFAPI_S1.md?ref_type=heads

Start the EPC (Evolved Packet Core) on machine A. This is a prerequisite before starting the eNB and UE.

```bash
$ ssh sudousername@machineA
# Start the EPC
```

--------------------------------

### Compile libyang2 and libnetconf2 from Source

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Build instructions for installing the latest versions of libyang and libnetconf2 on Ubuntu.

```bash
rm -rf /tmp/build_mplane_v2
mkdir /tmp/build_mplane_v2

# libyang
cd /tmp/build_mplane_v2
git clone https://github.com/CESNET/libyang.git
cd libyang
git checkout v2.1.111
mkdir build && cd build
cmake -DENABLE_TESTS=OFF \
      -DENABLE_VALGRIND_TESTS=OFF \
      -DCMAKE_INSTALL_PREFIX=/usr/local \
      -DCMAKE_INSTALL_RPATH=/usr/local/lib \
      -DPLUGINS_DIR=/usr/local/lib/libyang \
      -DPLUGINS_DIR_EXTENSIONS=/usr/local/lib/libyang/extensions \
      -DPLUGINS_DIR_TYPES=/usr/local/lib/libyang/types \
      -DYANG_MODULE_DIR=/usr/local/share/yang/modules/libyang ..
make -j8
sudo make install
sudo ldconfig

#libnetconf
cd /tmp/build_mplane_v2
git clone https://github.com/CESNET/libnetconf2.git
cd libnetconf2
git checkout v2.1.37
mkdir build && cd build
cmake -DENABLE_TESTS=OFF \
      -DENABLE_EXAMPLES=OFF \
      -DENABLE_VALGRIND_TESTS=OFF \
      -DCLIENT_SEARCH_DIR=/usr/local/share/yang/modules \
      -DCMAKE_INSTALL_PREFIX=/usr/local \
      -DCMAKE_INSTALL_RPATH=/usr/local/lib \
      -DLIBYANG_INCLUDE_DIR=/usr/local/include \
      -DLIBYANG_LIBRARY=/usr/local/lib/libyang.so \
      -DLY_VERSION_PATH=/usr/local/include \
      -DYANG_MODULE_DIR=/usr/local/share/yang/modules/libnetconf2 ..
make -j8
sudo make install
sudo ldconfig

# to uninstall libraries
# cd /tmp/build_mplane_v2/libyang/build && sudo make uninstall
# cd /tmp/build_mplane_v2/libnetconf2/build && sudo make uninstall
# cd
# rm -rf /tmp/build_mplane_v2
```

--------------------------------

### Setup Local Network Interfaces

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/nfapi.md?ref_type=heads

Configure virtual network interfaces for O-DU, CU_stub, and RIC_stub communication.

```bash
sudo ifconfig <interface name>:ODU "192.168.130.81" 
sudo ifconfig <interface name>:CU_STUB "192.168.130.82"
sudo ifconfig <interface name>:RIC_STUB "192.168.130.80"
```

--------------------------------

### Install numactl

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/RUN_NR_PRS.md?ref_type=heads

Install the numactl package on Linux systems.

```bash
sudo apt-get install -y numactl
```

--------------------------------

### Start DU0 with RF Simulator

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/handover-tutorial.md

Initialize the first Distributed Unit (DU0) using the RF simulator. Ensure the configuration file path and RF simulator server address are correct.

```bash
sudo ./nr-softmodem --rfsim -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb-du.sa.band78.106prb.rfsim.pci0.conf --rfsimulator.[0].serveraddr 127.0.0.1
```

--------------------------------

### Install UHD Dependencies

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_COTS_UE.md

Installs essential development libraries required for building the UHD (Universal Hardware Driver) software. Ensure these are installed before proceeding with UHD compilation.

```bash
sudo apt install -y autoconf automake build-essential ccache cmake cpufrequtils doxygen ethtool g++ git inetutils-tools libboost-all-dev libncurses-dev libusb-1.0-0 libusb-1.0-0-dev libusb-dev python3-dev python3-mako python3-numpy python3-requests python3-scipy python3-setuptools python3-ruamel.yaml
```

--------------------------------

### Set container entry point and command

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.lteRU.ubuntu?ref_type=heads

Sets the working directory, copies the tini init process, and defines the container startup command.

```dockerfile
WORKDIR /opt/oai-lte-ru

COPY --from=ru-base /tini /tini
ENTRYPOINT ["/tini", "-v", "--", "/opt/oai-lte-ru/bin/entrypoint.sh"]
CMD ["/opt/oai-lte-ru/bin/oairu", "-O", "/opt/oai-lte-ru/etc/rru.conf"]
```

--------------------------------

### Install nrscope Dependencies

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/NR_SA_Tutorial_OAI_nrUE.md?ref_type=heads

Install the libforms library required for nrscope.

```bash
sudo apt install -y libforms-dev libforms-bin
```

--------------------------------

### Install Dependencies for LTE UE

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.lteUE.rocky?ref_type=heads

Installs essential packages for the LTE UE, including network tools, libraries, and Python packages for scripting. Ensures the system is up-to-date before installing.

```Dockerfile
RUN dnf update -y && \
    dnf install -y \
        lksctp-tools \
        procps-ng \
        tzdata \
        libusbx \
        libgfortran \
        gdb \
        python3 \
        python3-pip \
        iproute \
        net-tools \
        iputils && \
    pip3 install six && \
    pip3 install requests && \
    echo "/usr/local/lib" > /etc/ld.so.conf.d/local-lib.conf && \
    echo "/usr/local/lib64" >> /etc/ld.so.conf.d/local-lib.conf
```

--------------------------------

### Configure Container Entrypoint

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.nrORU.fhi72.ubuntu?ref_type=heads

Sets up the Tini init process and defines the container entrypoint and default command.

```dockerfile
COPY --from=ran-base /tini /tini
ENTRYPOINT ["/tini", "-v", "--", "/opt/nr-oru/bin/entrypoint.sh"]
CMD ["/opt/nr-oru/bin/nr-oru"]
```

--------------------------------

### Kernel Boot Parameters for CPU Isolation

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md?ref_type=heads

Example kernel command line arguments for isolating CPUs and configuring system behavior for real-time applications.

```text
isolcpus=0-15 nohz_full=0-15 rcu_nocbs=0-15 kthread_cpus=16-31 rcu_nocb_poll nosoftlockup default_hugepagesz=1GB hugepagesz=1G hugepages=20 amd_iommu=on iommu=pt mitigations=off skew_tick=1 selinux=0 enforcing=0 tsc=reliable nmi_watchdog=0 softlockup_panic=0 audit=0 vt.handoff=7
```

```text
mitigations=off usbcore.autosuspend=-1 intel_iommu=on intel_iommu=pt selinux=0 enforcing=0 nmi_watchdog=0 softlockup_panic=0 audit=0 skew_tick=1 isolcpus=managed_irq,domain,0,2,4,6,8,10,12,14,16 nohz_full=0,2,4,6,8,10,12,14,16 rcu_nocbs=0,2,4,6,8,10,12,14,16 rcu_nocb_poll intel_pstate=disable nosoftlockup cgroup_disable=memory mce=off hugepagesz=1G hugepages=40 hugepagesz=2M hugepages=0 default_hugepagesz=1G isolcpus=managed_irq,domain,0,2,4,6,8,10,12,14 kthread_cpus=18-35 intel_pstate=disable nosoftlockup tsc=reliable
```

--------------------------------

### Start OAI UE

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/E1AP/E1-design.md

Initializes the OAI UE with specific band, frequency, and rfsimulator server address parameters.

```bash
sudo ./nr-uesoftmodem -r 106 --numerology 1 --band 78 -C 3619200000 --rfsim --rfsimulator.[0].serveraddr 127.0.0.1
```

--------------------------------

### E1 Interface Setup Procedure Sequence Diagram

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/E1AP/E1-design.md

Illustrates the sequence of messages exchanged during the E1 Setup Procedure between CUCP and CUUP, including SCTP connection setup in split mode.

```mermaid
sequenceDiagram
  participant c as CUCP
  participant u as CUUP

  Note over c,u: E1 Setup Procedure
  u->c: SCTP connection setup (in split mode)
  u->>c: E1 Setup Request
  Note over c: Execute rrc_gNB_process_e1_setup_req()
  c->>u: E1 Setup Response
  c-->>u: E1 Setup Failure
```

--------------------------------

### Configure ptp4l

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/Aerial_FAPI_Split_Tutorial.md?ref_type=heads

Example configuration file for ptp4l located at /etc/ptp4l.conf.

```ini
[global]
domainNumber            24
slaveOnly               1
time_stamping           hardware
tx_timestamp_timeout    30

[your_PTP_ENABLED_NIC]
network_transport       L2
```

--------------------------------

### Install OAI Packages

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/packages.md

Commands to install generated packages on different Linux distributions.

```bash
dpkg -i liboai-common.deb liboai-usrp.deb oai-lte.deb oai-nr.deb oai-physim.deb
```

```bash
rpm -i liboai-common.rpm liboai-usrp.rpm oai-lte.rpm oai-nr.rpm oai-physim.rpm
```

--------------------------------

### Install UHD Driver

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/BUILD.md?ref_type=heads

Commands for installing the UHD driver from the Ettus PPA or from source.

```bash
./build_oai -I -w USRP
```

```bash
export BUILD_UHD_FROM_SOURCE=True
export UHD_VERSION=3.15.0.0
./build_oai -I -w USRP
```

--------------------------------

### Start DU0 and DU1

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/handover-tutorial.md?ref_type=heads

Initialize the Distributed Units using specific configuration files for the RFsimulator.

```bash
sudo ./nr-softmodem --rfsim -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb-du.sa.band78.106prb.rfsim.pci0.conf --rfsimulator.[0].serveraddr 127.0.0.1
```

```bash
sudo ./nr-softmodem --rfsim -O ../../../targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb-du.sa.band78.106prb.rfsim.pci1.conf --rfsimulator.[0].serveraddr 127.0.0.1
```

--------------------------------

### Initial UE Connection Setup Sequence Diagram

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/RRC/rrc-dev.md

Illustrates the principal steps for an initial UE connection, including RRC setup, NAS authentication, security procedures, and optional PDU session setup.

```sequenceDiagram
sequenceDiagram
  participant ue as UE
  participant du as DU
  participant cucp as CU-CP
  participant cuup as CU-UP
  participant amf as AMF

  ue->>du: Msg1/Preamble
  du->>ue: Msg2/RAR
  ue->>cucp: F1AP Initial UL RRC Msg Tr (RRC Setup Req, in Msg3)
  Note over cucp: rrc_handle_RRCSetupRequest()
  cucp->>ue: F1AP DL RRC Msg Transfer (RRC Setup, in Msg4)
  ue->>cucp: F1AP UL RRC Msg Transfer (RRC Setup Complete)
  Note over cucp: rrc_handle_RRCSetupComplete()
%% TODO: when is RRC connected?
  cucp->>amf: NGAP Initial UE Message (NAS Registration/Service Req)
  Note over amf,ue: NAS Authentication Procedure (see 24.501)
  Note over amf,ue: NAS Security Procedure (see 24.501)
  amf->>cucp: NGAP Initial Context Setup Req
  Note over cucp: rrc_gNB_process_NGAP_INITIAL_CONTEXT_SETUP_REQ()
  Note over cucp: rrc_gNB_generate_SecurityModeCommand()
  cucp->>ue: F1AP DL RRC Msg Transfer (RRC Security Mode Command)
  ue->>cucp: F1AP UL RRC Msg Transfer (RRC Security Mode Complete)
  Note over cucp: rrc_gNB_decode_dcch() (inline)
  opt No UE Capabilities present
    Note over cucp: rrc_gNB_generate_UECapabilityEnquiry()
    cucp->>ue: F1AP DL RRC Msg Transfer (RRC UE Capability Enquiry)
    ue->>cucp: F1AP UL RRC Msg Transfer (RRC UE Capability Information)
    Note over cucp: handle_ueCapabilityInformation()
  end
  opt PDU Sessions in NGAP Initial Context Setup Req present
    Note over cucp: trigger_bearer_setup()
    cucp->>cuup: E1AP Bearer Context Setup Req
    cuup->>cucp: E1AP Bearer Context Setup Resp
    Note over cucp: rrc_gNB_process_e1_bearer_context_setup_resp()
    cucp->>du: F1AP UE Context Setup Req
    du->>cucp: F1AP UE Context Setup Resp
    Note over cucp: rrc_CU_process_ue_context_setup_response()
    Note over cucp: e1_send_bearer_updates()
    cucp->>cuup: E1AP Bearer Context Modification Req
    cucp->>ue: F1AP DL RRC Msg Transfer (RRC Reconfiguration)
    cuup->>cucp: E1AP Bearer Context Modification Resp
    ue->>cucp: F1AP UL RRC Msg Transfer (RRC Reconfiguration Complete)
    Note over cucp: handle_rrcReconfigurationComplete()
  end
  Note over cucp: rrc_gNB_send_NGAP_INITIAL_CONTEXT_SETUP_RESP()
  cucp->>amf: NGAP Initial Context Setup Resp (NAS Registration/Service Complete)

```

--------------------------------

### Start CU/DU with Configuration

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/F1AP/F1-design.md?ref_type=heads

Execute the 'nr-softmodem' executable with specific configuration files to start either a CU or DU. Ensure you have the correct path to the executable and configuration files.

```bash
sudo cmake_targets/ran_build/build/nr-softmodem -O ci-scripts/conf_files/gnb-cu.sa.band78.106prb.conf
```

```bash
sudo cmake_targets/ran_build/build/nr-softmodem -O ci-scripts/conf_files/gnb-du.sa.band78.106prb.rfsim.conf
```

--------------------------------

### Install Mandatory Packages

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Commands to install required development libraries on Fedora and Ubuntu systems.

```bash
sudo dnf install pcre-devel libssh-devel libxml2-devel libyang2-devel libnetconf2-devel
```

```bash
sudo apt-get install libpcre3-dev libssh-dev libxml2-dev
```

--------------------------------

### Verify DPDK Installation

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Check if the LD cache contains the DPDK Shared Objects after installation.

```bash
sudo ldconfig -v | grep rte_
```

--------------------------------

### Install System Dependencies

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/data_recording.md?ref_type=heads

Commands to update the package list and install necessary system-level libraries.

```bash
sudo apt-get update
sudo apt-get install -y python3-sysv-ipc libxft-dev
```

--------------------------------

### Install clang-format-12

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/clang-format.md

Commands to remove existing clang-format versions and install the required version 12.

```bash
$ sudo apt-get remove clang-format*
$ sudo apt-get install clang-format-12
```

--------------------------------

### Launch RU Emulator

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Start the RU emulator for ProtO-RU using a specified configuration file. Ensure DU and ProtO-RU host are PTP synchronized before launching.

```bash
sudo ./ru_emulator -c <path-to/protoru-OAI-B210-TDD-n78-40MHz-1x1-30kHz.yml>
```

--------------------------------

### Install linuxptp package

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/Aerial_FAPI_Split_Tutorial.md?ref_type=heads

Install the linuxptp package on Ubuntu systems to enable PTP support.

```bash
#Ubuntu
sudo apt install linuxptp -y
```

--------------------------------

### Create Target PHY Simulation Image

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/docker/Dockerfile.phySim.rhel9?ref_type=heads

Sets up the base image for the PHY simulation, installs necessary runtime dependencies, and copies the compiled binaries and libraries from the build stage.

```dockerfile
FROM registry.redhat.io/ubi9/ubi:latest AS oai-physim

RUN dnf update -y && \
    dnf install -y \
        lksctp-tools \
        tzdata \
        libgfortran \
        hostname \
        sudo \
        procps-ng \
        net-tools \
        iputils \
        cmake \
        bc \
        iproute && \
    echo "/usr/local/lib" > /etc/ld.so.conf.d/local-lib.conf && \
    echo "/usr/local/lib64" >> /etc/ld.so.conf.d/local-lib.conf

WORKDIR /opt/oai-physim/bin
COPY --from=phy-sim-build /opt/oai-physim/bin/ /opt/oai-physim/bin/

COPY --from=phy-sim-build \
    /oai-ran/cmake_targets/ran_build/build/libcoding.so \
    /usr/lib64/libasan.so.6 \
    /usr/lib64/libubsan.so.1 \
    /oai-ran/cmake_targets/ran_build/build/libdfts.so \
    /oai-ran/cmake_targets/ran_build/build/libldpc*.so \
    /usr/local/lib/

RUN ldconfig && \
    echo "---- ldd on physim executables ----" && \
    ldd /opt/oai-physim/bin/dlsim \
        /opt/oai-physim/bin/nr_dlsim \
        /opt/oai-physim/bin/nr_prachsim \
        /opt/oai-physim/bin/nr_ulschsim \
        /opt/oai-physim/bin/polartest \
        /opt/oai-physim/bin/ulsim \
        /opt/oai-physim/bin/ldpctest \
        /opt/oai-physim/bin/nr_dlschsim \
        /opt/oai-physim/bin/nr_pbchsim \
        /opt/oai-physim/bin/nr_psbchsim \
        /opt/oai-physim/bin/nr_pucchsim \
        /opt/oai-physim/bin/nr_ulsim \
        /opt/oai-physim/bin/smallblocktest && \
    echo "---- ldd on shared libraries ----" && \
    ldd /usr/local/lib/libcoding.so \
        /usr/local/lib/libdfts.so \
        /usr/local/lib/libldpc*.so

# Copy the relevant configuration files for phySim
WORKDIR /opt/oai-physim/

COPY --from=phy-sim-build \
    /oai-ran/cmake_targets/ran_build/build/openair1/SIMULATION/tests/CTestTestfile.cmake \
    /opt/oai-physim/

RUN mkdir -p /oai-ran/openair1/SIMULATION/tests

COPY --from=phy-sim-build \
    /oai-ran/openair1/SIMULATION/tests/RunTimedTest.cmake \
    /oai-ran/openair1/SIMULATION/tests/analyze-timing.sh \
    /oai-ran/openair1/SIMULATION/tests/

#CMD ["sleep", "infinity"]
```

--------------------------------

### Set PKG_CONFIG_PATH for Custom Installations

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/ORAN_FHI7.2_Tutorial.md

Point to the correct directory for pkg-config if DPDK was installed in a custom location.

```bash
export PKG_CONFIG_PATH=$PKG_CONFIG_PATH:/usr/local/lib64/pkgconfig/
pkg-config --libs libdpdk --static
```

--------------------------------

### Install OAI Packages on RHEL/Fedora

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/packages.md?ref_type=heads

Command to install OAI packages on RHEL/Fedora systems using rpm.

```bash
rpm -i liboai-common.rpm liboai-usrp.rpm oai-lte.rpm oai-nr.rpm oai-physim.rpm
```

--------------------------------

### Build PHY Simulators

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/UL_MIMO.md

Command to build the PHY simulators for OpenAirInterface5G. This command should be executed from the root of the project directory.

```bash
cd cmake_targets/\n    sudo ./build_oai --phy_simulators -c\n    cd phy_simulators/build/
```

--------------------------------

### Install OAI Packages on Ubuntu/Debian

Source: https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/develop/doc/packages.md?ref_type=heads

Command to install OAI packages on Ubuntu/Debian systems using dpkg.

```bash
dpkg -i liboai-common.deb liboai-usrp.deb oai-lte.deb oai-nr.deb oai-physim.deb
```
Tokens:
Raw