UERANSIM

Open source 5G UE and RAN (gNodeB) simulator. This tool can be used as UE/RAN emulator with additional capability of load testing.

General Info

3GPP Release: R15
Access Type: 5G-SA (Standalone Access)
Connection Type: 3GPP Access

Features

• UE | Registration
  • Initial Registration
  • Periodic Registration
  • UE/Network Initiated de-registration
• UE | Authentication
  • EAP AKA'
  • 5G AKA
• NAS Encryption
  • EA1, EA2, EA3
  • IA1, IA2, IA3
• UE | MM Common Procedures
  • Security Mode Control
  • Identification
  • Generic UE Configuration Update
• gNB | Interface Management
  • NG Setup
  • Error Indication
• gNB | UE Context Management
  • Initial Context Setup
  • UE Context Release (AMF initiated)
  • UE Context Modification
• gNB | NAS Transport
  • Initial UE Message
  • Uplink/Downlink NAS Transport
• Session Management
  • PDU Session Establishment
• todo...

Requirements

1. Ubuntu 16.04 or later
2. OpenJDK 11 or later
3. g++/gcc version 6.4.0 or later

Dependencies

sudo apt update
sudo apt upgrade
sudo apt install make
sudo apt install g++
sudo apt install openjdk-11-jdk
sudo apt install maven
sudo apt install libsctp-dev lksctp-tools

Building

1. Make sure that JAVA_HOME variable is set.
2. Run the following command:

   ./build.sh
   

Running

1. Select a configuration profile by modifying config/profile.yaml.
2. (Optional) You can further modify the profile configurations if you want. (config/open5gs, config/free5gc, etc.)
3. Execute ./run.sh to start the application.
4. Use tail -f to monitor logs realtime located at logs/*.log.
5. Use terminal to trigger test events such as initial-registration

FAQ

Q1. Why am I getting java.net.SocketException: Protocol not supported exception?

This error usually happens if you are using some Linux VM container in Windows. Windows does not support SCTP protokol, therefore physical Linux machine is required. Otherwise SCTP won't work.

Also it is possible that your specific Linux distribution does not support SCTP. However Ubuntu 16.04 and later should support it.

Q2. Why am I getting java.net.ConnectException: Connection refused exception?

This error means SCTP connection could not established between RAN and AMF. Therefore make sure these 3 following conditions:

1. AMF is running and listening NGAP port (38412).
2. AMF's NGAP IP address and port number exactly matches with gnb.yaml config file.
3. AMF is reachable by RAN over the network. (Check firewall etc.)

Q3. I can't build native libraries.

Make sure that you set the JAVA_HOME environment variable, and have correct version of gcc/g++. You can check the current version with gcc -v. In order to upgrade gcc/g++ run the following command:

sudo apt update
sudo apt upgrade
sudo apt install g++

Q4. How to increase the number of UE and RANs?

In order to increase the number of UEs, you can change the number-of-UE value in config/testing.yaml. Multiple RAN feature is in progress now.