Files
openairinterface5g/doc
Robert Schmidt 07629e29d6 Add CU-UP load tester and documentation
This is a simple CU-UP load tester. It sets up a configurable number of UEs in the
CU-UP, then sends GTP traffic in downlink/uplink in the N3-F1/F1-N3
direction at the CU-UP. It then compares the sent and received data.

Additional parameters, such as amount of traffic, test length, packet
size, and IP addresses/ports are configurable.

To run:

    mkdir build && cd build && cmake .. -GNinja && ninja nr-cuup nr-cuup-load-test params_libconfig
    ./tests/nr-cuup/nr-cuup-load-test
    ./nr-cuup -O ../tests/nr-cuup/load-test.conf

The tester should be able to detect lost and reordered packets.

Example lost: Receive order 2,3,5,6 (lost packet 4)
=> on packet 2, expected 2, next=expected+1=3
=> on packet 3, expected 3, next=expected+1=4
=> on packet 5, expected 4, diff=5-4=1 (lost 1), next=payload+1=6
=> on packet 6, expected 6
=> 1 lost

Example reordered: Receiver order 2,5,3,6 (lost packet 4)
=> on packet 2, expected 2, next=expected+1=3
=> on packet 5, expected 3, diff=5-3=2 (lost 2), next=payload+1=6
=> on packet 3, expected 6, (reduce lost by 1 to 1), next=expected=6
=> on packet 6, expected 6
=> 1 lost

Example reordered: Receiver order 2,5,3,4,6 (no losses)
2025-08-04 12:31:05 +02:00
..
2021-10-27 22:36:33 +00:00
2025-04-15 16:02:34 +02:00
2025-04-14 11:39:08 +02:00
2024-10-11 09:12:49 +02:00
2022-09-29 10:03:28 +02:00
2025-04-18 09:02:54 +02:00
2025-07-22 18:17:58 +02:00
2021-12-07 13:47:15 +08:00

OpenAirInterface documentation overview

This is the general overview page of the OpenAirInterface documentation.
This page groups links to general information, tutorials, design documents, radio integration, and special-purpose libraries.

IMPORTANT NOTE:
Before reading this documentation, we strongly advise you to keep your own repository rebased on develop or at least to checkout the documentation on the version of the repository you are using.
Then the documentation will better reflect the features available in your repository so that you may avoid some errors.
Beware if you previously pulled the develop branch that your repository may be now behind develop.

[[TOC]]

General

There is some general information in the OpenAirInterface Gitlab Wiki

Tutorials

Legacy unmaintained files:

Designs

Building and running from images

Libraries

General

Radios

Some directories under radio contain READMEs:

The other SDRs (AW2S, LimeSDR, ...) have no READMEs.

Special-purpose libraries

  • OAI has two scopes: one based on Xforms and one based on imgui, described in this README
  • OAI comes with an integrated telnet server to monitor and control
  • OAI comes with an integrated web server

Testing

  • UnitTests.md explains the unit testing setup
  • Component tests are under tests/. Currently, there is a simple CU-UP tester, see the corresponding README.md.
  • TESTBenches.md lists the CI setup and links to pipelines

Developer tools

  • formatting is a clang-format error detection tool
  • iwyu is a tool to detect #include errors
  • docker-dev-env is a ubuntu22 docker development environment