mirror of
https://gitlab.eurecom.fr/oai/openairinterface5g.git
synced 2026-07-13 04:30:28 +00:00
438de535fa
- make internal links relative where applicable - delete link to the wiki, as the documentation is in the main repo, not the wiki - remove some "example in oai code" as the examples either don't exist, or are not in that place, and we can reasonably expect people to grep Signed-off-by: Robert Schmidt <robert.schmidt@openairinterface.org>
323 lines
9.8 KiB
Markdown
323 lines
9.8 KiB
Markdown
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
|
|
|
|
# L2 nFAPI Simulator (no S1 Mode / 2-host deployment)
|
|
|
|
> **2022/03/08: CAUTION, THIS TUTORIAL IS NO LONGER VALID on the `develop` branch after the `2022.w01` tag.**
|
|
|
|
> **2022/03/08: CAUTION, THE LAST VALID TAG on `develop` branch is `2021.w51_c`.**
|
|
|
|
**Table of Contents**
|
|
|
|
[[_TOC_]]
|
|
|
|
## 1. Environment
|
|
|
|
You may not have access to an EPC or you don't want to hassle to deploy one.
|
|
|
|
2 servers are used in this deployment. You can use Virtual Machines instead of each server; like it is done in the CI process.
|
|
|
|
* Machine B contains the OAI eNB executable (`lte-softmodem`)
|
|
* Machine C contains the OAI UE(s) executable (`lte-uesoftmodem`)
|
|
|
|
Example of L2 nFAPI Simulator testing environment:
|
|
|
|
|
|
|
|
> Note that the IP addresses are indicative and need to be adapted to your environment.
|
|
|
|
## 2. Retrieve the OAI eNB-UE source code
|
|
|
|
At the time of writing, the tag used in the `develop` branch to do this documentation was `2020.w16`.
|
|
|
|
The tutorial should be valid for the `master` branch tags such as `v1.2.0` or `v1.2.1`. But you may face issues that could be fixed in newer `develop` tags.
|
|
|
|
Please try to use the same commit ID on both eNB/UE hosts.
|
|
|
|
```bash
|
|
$ ssh sudousername@machineB
|
|
git clone https://github.com/duranta-project/openairinterface5g.git enb_folder
|
|
cd enb_folder
|
|
git checkout develop
|
|
```
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
git clone https://github.com/duranta-project/openairinterface5g.git ue_folder
|
|
cd ue_folder
|
|
git checkout develop
|
|
```
|
|
|
|
## 3. Setup of the USIM information in UE folder
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
cd ue_folder
|
|
# Edit openair3/NAS/TOOLS/ue_eurecom_test_sfr.conf with your preferred editor
|
|
```
|
|
|
|
Edit the USIM information within this file in order to match the HSS database. They **HAVE TO** match:
|
|
|
|
* PLMN+MSIN and IMSI of users table of HSS database **SHALL** be the same.
|
|
* OPC of this file and OPC of users table of HSS database **SHALL** be the same.
|
|
* USIM_API_K of this file and the key of users table of HSS database **SHALL** be the same.
|
|
|
|
When testing multiple UEs, it is necessary to add other UEs information like described below for 2 Users. Only UE0 (first UE) information is written in the original file.
|
|
|
|
```
|
|
UE0:
|
|
{
|
|
USER: {
|
|
IMEI="356113022094149";
|
|
MANUFACTURER="EURECOM";
|
|
MODEL="LTE Android PC";
|
|
PIN="0000";
|
|
};
|
|
|
|
SIM: {
|
|
MSIN="0000000001"; // <-- Modify here
|
|
USIM_API_K="8baf473f2f8fd09487cccbd7097c6862";
|
|
OPC="e734f8734007d6c5ce7a0508809e7e9c";
|
|
MSISDN="33611123456";
|
|
};
|
|
...
|
|
};
|
|
// Copy the UE0 and edit
|
|
UE1: // <- Edit here
|
|
{
|
|
USER: {
|
|
IMEI="356113022094149";
|
|
MANUFACTURER="EURECOM";
|
|
MODEL="LTE Android PC";
|
|
PIN="0000";
|
|
};
|
|
|
|
SIM: {
|
|
MSIN="0000000002"; // <-- Modify here
|
|
USIM_API_K="8baf473f2f8fd09487cccbd7097c6862";
|
|
OPC="e734f8734007d6c5ce7a0508809e7e9c";
|
|
MSISDN="33611123456";
|
|
};
|
|
...
|
|
};
|
|
```
|
|
|
|
You can repeat the operation for as many users you want to test with.
|
|
|
|
## 4. Setup of the Configuration files
|
|
|
|
> **CAUTION: both proposed configuration files resides in the ci-scripts realm. You can copy them but you CANNOT push any modification on these 2 files as part of an MR without informing the CI team.**
|
|
|
|
### 4.1. The eNB Configuration file
|
|
|
|
```bash
|
|
$ ssh sudousername@machineB
|
|
cd enb_folder
|
|
# Edit ci-scripts/conf_files/rcc.band7.tm1.nfapi.conf with your preferred editor
|
|
```
|
|
|
|
First verify the nFAPI interface setup on the physical ethernet interface of machineB and put the proper IP addresses for both hosts.
|
|
|
|
```
|
|
MACRLCs = (
|
|
{
|
|
num_cc = 1;
|
|
remote_s_address = "192.168.122.169"; // <-- HERE
|
|
local_s_address = "192.168.122.31"; // <-- HERE
|
|
local_s_portc = 50001;
|
|
remote_s_portc = 50000;
|
|
local_s_portd = 50011;
|
|
remote_s_portd = 50010;
|
|
tr_s_preference = "nfapi";
|
|
tr_n_preference = "local_RRC";
|
|
}
|
|
);
|
|
```
|
|
|
|
If you are testing more than 16 UEs, a proper setting on the RUs is necessary.
|
|
> **Note that this part is NOT present in the original configuration file**.
|
|
|
|
```
|
|
RUs = (
|
|
{
|
|
local_rf = "yes"
|
|
nb_tx = 1
|
|
nb_rx = 1
|
|
att_tx = 20
|
|
att_rx = 0;
|
|
bands = [38];
|
|
max_pdschReferenceSignalPower = -23;
|
|
max_rxgain = 116;
|
|
eNB_instances = [0];
|
|
}
|
|
);
|
|
```
|
|
|
|
Last, the S1 interface shall be properly set.
|
|
|
|
```
|
|
////////// MME parameters:
|
|
mme_ip_address = ({ ipv4 = "CI_MME_IP_ADDR"; }); // replace with 192.168.122.195
|
|
|
|
NETWORK_INTERFACES :
|
|
{
|
|
ENB_IPV4_ADDRESS_FOR_S1_MME = "CI_ENB_IP_ADDR"; // replace with 192.168.122.31
|
|
ENB_IPV4_ADDRESS_FOR_S1U = "CI_ENB_IP_ADDR"; // replace with 192.168.122.31
|
|
ENB_PORT_FOR_S1U = 2152; # Spec 2152
|
|
ENB_IPV4_ADDRESS_FOR_X2C = "CI_ENB_IP_ADDR"; // replace with 192.168.122.31
|
|
ENB_PORT_FOR_X2C = 36422; # Spec 36422
|
|
|
|
};
|
|
```
|
|
|
|
### 4.2. The UE Configuration file
|
|
|
|
```bash
|
|
$ ssh sudousername@machineB
|
|
cd ue_folder
|
|
# Edit ci-scripts/conf_files/nrue.uicc.conf with your preferred editor
|
|
```
|
|
|
|
Verify the nFAPI interface setup on the loopback interface.
|
|
|
|
```
|
|
L1s = (
|
|
{
|
|
num_cc = 1;
|
|
tr_n_preference = "nfapi";
|
|
remote_n_address = "192.168.122.31"; // <- HERE
|
|
local_n_address = "192.168.122.169"; // <- HERE
|
|
local_n_portc = 50000;
|
|
remote_n_portc = 50001;
|
|
local_n_portd = 50010;
|
|
remote_n_portd = 50011;
|
|
}
|
|
);
|
|
```
|
|
|
|
## 5. Build OAI UE and eNodeB
|
|
|
|
See [Build documentation](./BUILD.md).
|
|
|
|
## 6. Start the eNB
|
|
|
|
In the first terminal (the one you used to build the eNB):
|
|
|
|
```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
|
|
....
|
|
```
|
|
|
|
If you don't use redirection, you can test but many logs are printed on the console and this may affect performance of the L2-nFAPI simulator.
|
|
|
|
We do recommend the redirection in steady mode once your setup is correct.
|
|
|
|
## 7. Start the UE
|
|
|
|
In the second terminal (the one you used to build the UE):
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
cd ue_folder/cmake_targets
|
|
# Test 64 UEs, 1 thread in FDD mode
|
|
sudo -E ./ran_build/build/lte-uesoftmodem -O ../ci-scripts/conf_files/nrue.uicc.conf --noS1 --L2-emul 3 --num-ues 64 --nums_ue_thread 1 > ue.log 2>&1
|
|
# Test 64 UEs, 1 thread in TDD mode
|
|
sudo -E ./ran_build/build/lte-uesoftmodem -O ../ci-scripts/conf_files/nrue.uicc.conf --noS1 --L2-emul 3 --num-ues 64 --nums_ue_thread 1 -T 1 > ue.log 2>&1
|
|
# The "-T 1" option means TDD config
|
|
```
|
|
|
|
- The number of UEs can set by using `--num-ues` option and the maximum UE number is 255 (with the `--mu*` options, otherwise 16).
|
|
- The number of threads can set with the `--nums-ue-thread`. This number **SHALL NOT** be greater than the number of UEs.
|
|
* At the time of writing, it seems to be enough to run on a single thread.
|
|
- How many UE that can be tested depends on hardware (server , PC, etc) performance in your environment.
|
|
|
|
For example, running with 4 UEs:
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
cd ue_folder/cmake_targets
|
|
sudo -E ./ran_build/build/lte-uesoftmodem -O ../ci-scripts/conf_files/nrue.uicc.conf --noS1 --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:10.0.1.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:10.0.1.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:10.0.1.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:10.0.1.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
|
|
....
|
|
....
|
|
```
|
|
|
|
Having the 4 oaitun_ue tunnel interfaces up and with an allocated address means the connection with EPC went alright.
|
|
|
|
## 8. Test with ping
|
|
|
|
In a third terminal, after around 10 seconds, the UE(s) shall be connected to the eNB: Check with ifconfig
|
|
|
|
```bash
|
|
$ ssh sudousername@machineB
|
|
# Ping UE1 IP address based on the EPC pool used: in this example:
|
|
ping -I oaitun_enb1 -c 20 10.0.1.2
|
|
# Ping UE4 IP address based on the EPC pool used: in this example:
|
|
ping -I oaitun_enb1 -c 20 10.0.1.5
|
|
```
|
|
|
|
Ping from the UE side:
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
ping -I oaitun_ue1 -c 20 10.0.1.1
|
|
ping -I oaitun_ue3 -c 20 10.0.1.1
|
|
```
|
|
|
|
iperf operations can also be performed.
|
|
|
|
DL traffic:
|
|
|
|
```bash
|
|
$ ssh sudousername@machineC
|
|
iperf -B 10.0.1.2 -u -s -i 1 -fm -p 5002
|
|
$ ssh sudousername@machineB
|
|
iperf -c 10.0.1.2 -u -t 30 -b 3M -i 1 -fm -B 10.0.1.1 -p 5002
|
|
```
|
|
|
|
UL traffic:
|
|
|
|
```bash
|
|
$ ssh sudousername@machineB
|
|
iperf -B 10.0.1.1 -u -s -i 1 -fm -p 5002
|
|
$ ssh sudousername@machineC
|
|
iperf -c 10.0.1.1 -u -t 30 -b 2M -i 1 -fm -B 10.0.1.2 -p 5002
|
|
```
|
|
|
|
## 9. Limitations
|
|
|
|
|
|
----
|
|
|
|
[oai softmodem features](FEATURE_SET.md)
|
|
|
|
[oai softmodem build procedure](BUILD.md)
|
|
|
|
[L2 nfapi simulator](L2NFAPI.md)
|