.clang-format

@@ -9,9 +9,10 @@ AlignEscapedNewlines: Left
 AlignOperands:   true
 AlignTrailingComments: false
 AllowAllParametersOfDeclarationOnNextLine: false
+AllowAllArgumentsOnNextLine: false
 AllowShortBlocksOnASingleLine: false
 AllowShortCaseLabelsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: None
+AllowShortFunctionsOnASingleLine: false
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false
 AlwaysBreakAfterDefinitionReturnType: None
@@ -44,7 +45,7 @@ BreakBeforeTernaryOperators: true
 BreakConstructorInitializersBeforeComma: false
 BreakConstructorInitializers: BeforeColon
 BreakStringLiterals: true
-ColumnLimit:     200
+ColumnLimit:     132
 CommentPragmas:  '^ IWYU pragma:'
 CompactNamespaces: false
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
@@ -59,6 +60,8 @@ ForEachMacros:
   - foreach
   - Q_FOREACH
   - BOOST_FOREACH
+  - RB_FOREACH
+  - UE_iterator
 IncludeBlocks:   Preserve
 IncludeCategories:
   - Regex:           '^<ext/.*\.h>'
@@ -103,5 +106,85 @@ SpacesInParentheses: false
 SpacesInSquareBrackets: false
 TabWidth:        2
 UseTab:          Never
+---
+Language: JavaScript
+# BasedOnStyle:  Google
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignOperands:   true
+AlignTrailingComments: false
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+BinPackArguments: false
+BinPackParameters: false
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   true
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: NonAssignment
+BreakBeforeBraces: Custom
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakStringLiterals: true
+ColumnLimit:     200
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DisableFormat:   false
+FixNamespaceComments: true
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: false
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+ReflowComments:  true
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+DeriveLineEnding: true
+TabWidth:        2
+JavaScriptQuotes: Double 
+UseTab:          Never
 ...
 

.dockerignore

@@ -5,4 +5,3 @@ common/utils/T/T_IDs.h
 common/utils/T/T_messages.txt.h
 common/utils/T/genids
 common/utils/T/genids.o
-targets/bin/

.gitignore

@@ -8,10 +8,12 @@ cmake_targets/ran_build/
 cmake_targets/nas_sim_tools/build/
 log/
 lte_build_oai/
-targets/bin/
 
-# vscode
+# IDE files
 .vscode
+.cproject
+.project
+.settings
 
 # Tags for vim/global
 GPATH
@@ -23,3 +25,4 @@ tags
 nfapi_nr_interface_scf
 *.log
 *.out
+CMakeUserPresets.json

.gitmodules

+[submodule "openair2/E2AP/flexric"]
+	path = openair2/E2AP/flexric
+	url = https://gitlab.eurecom.fr/mosaic5g/flexric.git
+	branch = remotes/origin/service-models-integration

.vscode/launch.json

-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "(gdb) Launch",
-            "type": "cppdbg",
-            "request": "launch",
-            "program": "${workspaceFolder}/cmake_targets/ran_build/build/lte-softmodem",
-            "args": [
-                "-O", "../ci-scripts/conf_files/rcc.band7.tm1.nfapi.conf",
-                "--noS1"
-            ],
-            "stopAtEntry": false,
-            "cwd": "${workspaceFolder}/cmake_targets",
-            "environment": [],
-            "externalConsole": false,
-            "MIMode": "gdb",
-            "miDebuggerPath": "${workspaceFolder}/cmake_targets/sudo-gdb",
-            "setupCommands": [
-                {
-                    "description": "Enable pretty-printing for gdb",
-                    "text": "-enable-pretty-printing",
-                    "ignoreFailures": true
-                }
-            ]
-        }
-    ]
-}

CHANGELOG.md

 # RELEASE NOTES: #
 
+## [v2.2.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.2.0) -> November 2024. ##
+
+General 5G improvements (both gNB and UE):
+- Make standalone mode (SA) the default (see [`RUNMODEM.md`](doc/RUNMODEM.md))
+- Experimental support for FR2 operation
+- Support for GEO NTN and simulation of GEO satellite channel in RFsimulator
+  (see [`RUNMODEM.md`](doc/RUNMODEM.md))
+- Support 2-step RA
+- Add optional LTTng logger in logging module (see
+  [`lttng_logs.md`](common/utils/LOG/DOC/lttng_logs.md))
+- Support for YAML-based config files (alongside libconfig) (see
+  [`gnb.sa.band78.106prb.rfsim.yaml`](ci-scripts/conf_files/gnb.sa.band78.106prb.rfsim.yaml) and
+  [`nrue.uicc.yaml`](ci-scripts/conf_files/nrue.uicc.yaml))
+- Add new L1 scope based on Dear ImGui (see [`readme.md`](openair1/PHY/TOOLS/readme.md))
+- Allow cross-compilation on ARM (via SIMDE SIMD emulation library)
+- Allow to build and run with clang
+- Support/check for Linux capabilities, allow to run without sudo (see
+  [`tuning_and_security.md`](doc/tuning_and_security.md))
+- OAI does not modify CPU frequency and networking stack
+  ([`tuning_and_security.md`](doc/tuning_and_security.md))
+- Bugfixes in the entire stack (e.g.  #547, #663, #674, #687, #712, #736, #739,
+  #741, #756, #762, #773, ...)
+
+5G gNB:
+- Support for FR2 interoperability with COTS UE (no beam switching supported yet)
+- Add 4-layer DL MIMO (experimental)
+- Add gNB Neighbour configuration and Mobility over F1 interface (see
+  [`handover-tutorial.md`](doc/handover-tutorial.md))
+- Enhance O-RAN FHI 7.2: (see [`ORAN_FHI7.2_Tutorial.md`](doc/ORAN_FHI7.2_Tutorial.md))
+  * Support different bandwidths (40/60/80/100MHz) and antenna configs (1x1 up
+    to 4x4) for Benetel/VVDN/LITEON RUs
+  * Add support for multi-RU support (single-cell/distributed antenna)
+- Support AMD T2 Telco card look-aside L1 accelerator (see
+  [`LDPC_T2_OFFLOAD_SETUP.md`](doc/LDPC_T2_OFFLOAD_SETUP.md))
+- Support Nvidia Aerial/ARC in-line L1 accelerator (see
+  [`Aerial_FAPI_Split_Tutorial.md`](doc/Aerial_FAPI_Split_Tutorial.md))
+- Various fixes for multi-UE operation: by default support of up to 16 UEs concurrently
+- Documentation for
+  - 5G MAC (see [`mac-usage.md`](doc/MAC/mac-usage.md))
+  - 5G RRC (see [`rrc-usage.md`](doc/RRC/rrc-usage.md))
+  - E1 (see [`E1-design.md`](doc/E1AP/E1-design.md))
+  - F1 (see [`F1-design.md`](doc/F1AP/F1-design.md))
+
+5G UE:
+- Basic interoperability with COTS gNB (Nokia gNB)
+- Implement PHR reporting
+- Implement RRC re-establishment
+- Implement PUCCH/PUSCH/SRS power control
+- Implement UCI on PUSCH and aperiodic CSI reporting
+- Support of cell search (within the selected UE bandwidth) (see [`RUNMODEM.md`](doc/RUNMODEM.md))
+- Enhance connection control: implement timers, resync
+- A lot of internal cleanup
+
+This release also includes many fixes and documentation updates. See
+`doc/README.md` in the repository for an overview of documentation.
+
+## [v2.1.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.1.0) -> February 2024. ##
+
+This release improves existing 5G support and adds various new features.
+
+* 5G gNB
+  - Add support for O-RAN 7.2 fronthaul interface
+    (tested with 3 O-RUs: Benetel, LITEON, VVDN)
+  - Add support for 2-layer UL MIMO
+  - FDD interoperability with COTS UE
+  - Compiles on ARM (through SIMDE)
+  - Introduce E2 agent and basic support for E2SM-KPM and E2SM-RC
+  - Add support for E1AP
+  - Add support for multiple DUs and CU-UPs at one CU-CP
+  - FR2 SA with OAI UE
+  - Improve computational efficiency
+* 5G UE
+  - Cleanup in MAC and RRC towards support of 3rd-party gNB
+  - FR2 SA with OAI gNB
+  - Improve computational efficiency
+
+Overall the stability is improved for the same resource usage.
+
+There is basic FR2 support between OAI gNB and OAI nrUE. COTS UE
+interoperability is under testing.
+
+This release also includes many fixes and documentation updates.
+
+## [v2.0.0](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v2.0.0) -> August 2023. ##
+
+This release adds support for 5G and maintains previous features:
+* 5G SA in gNB
+  - PHY, MAC, RLC, PDCP, SDAP, RRC layers
+  - 2x2 MIMO and 256-QAM for UL/DL
+  - 15 and 30 kHz subcarrier spacings; 10-100 MHz bandwidths
+  - Up to 800Mbps throughput or 5ms latency
+  - F1, basic E1, 5G FAPI (SCF 222.10.02), split 8 split options
+  - Handling of up to 16 UEs
+  - RRC procedures for connection setup, multiple PDU sessions, reestablishment
+* 5G SA in UE
+  - PHY, MAC, RLC, PDCP, SDAP, RRC layers
+  - 2x2 MIMO and 256-QAM for UL/DL
+  - 15 and 30 kHz subcarrier spacings; 10-100 MHz bandwidths
+  - Custom FAPI-like MAC/PHY interface
+  - RRC procedures for connection setup and cell measurement
+* Basic 5G NSA in gNB
+  - X2 sgNB Addition Request between OAI eNB and gNB
+* 4G eNB and UE
+  - Bugfixes in fairRR scheduler (eNB)
+  - Non-standard F1 midhaul removed (eNB)
+  - FlexRAN removed (eNB)
+  - Sync fixes (UE)
+* LTE-M supported
+* Support for AW2S devices, RFsimulator channel emulation support
+
+For more information on supported features, please refer to the [feature set](doc/FEATURE_SET.md).
+
 ## [v1.2.1](https://gitlab.eurecom.fr/oai/openairinterface5g/-/tags/v1.2.1) -> February 2020. ##
 
 * Bug fix for mutex lock for wake-up signal

CMakePresets.json

+{
+    "version": 3,
+    "configurePresets": [
+        {
+            "name": "default",
+            "displayName": "Default Config",
+            "description": "Default build using Ninja generator",
+            "generator": "Ninja",
+            "binaryDir": "${sourceDir}/cmake_targets/ran_build/build",
+            "cacheVariables": {
+                "CMAKE_BUILD_TYPE": "RelWithDebInfo"
+            }
+        },
+        {
+            "name": "tests",
+            "displayName": "Default unit test config",
+            "inherits": "default",
+            "binaryDir": "${sourceDir}/cmake_targets/ran_build/build_test",
+            "cacheVariables": {
+                "ENABLE_TESTS": "ON",
+                "SANITIZE_ADDRESS": "ON",
+                "CMAKE_BUILD_TYPE": "RelWithDebInfo"
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "5gdefault",
+            "configurePreset": "default",
+            "targets": [
+                "nr-uesoftmodem",
+                "nr-softmodem",
+                "rfsimulator",
+                "dfts",
+                "ldpc",
+                "params_libconfig",
+                "params_yaml"
+            ]
+        },
+        {
+            "name": "default",
+            "inherits": "5gdefault"
+        },
+        {
+            "name": "4gdefault",
+            "configurePreset": "default",
+            "targets": [
+                "lte-softmodem",
+                "lte-uesoftmodem",
+                "dfts",
+                "coding",
+                "rfsimulator",
+                "params_libconfig"
+            ]
+        },
+        {
+            "name": "tests",
+            "configurePreset": "tests",
+            "targets": [
+                "tests"
+            ]
+        }
+    ]
+}

CONTRIBUTING.md

@@ -2,21 +2,29 @@
 
 We want to make contributing to this project as easy and transparent as possible.
 
+Please refer to the steps described on our website: [How to contribute to OAI](https://www.openairinterface.org/?page_id=112).
+
 1. Sign and return a Contributor License Agreement to OAI team.
-2. We recommend that you provide us with a professional or student email address 
-2. Register on [Eurecom GitLab Server](https://gitlab.eurecom.fr/users/sign_in)
-3. Provide the OAI team with the **username** of this account to (mailto:contact@openairinterface.org) ; we will give you the developer rights on this repository.
-4. The policies are described in these wiki pages: [OAI Policies](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/oai-policies-home)
-   - PLEASE DO NOT FORK the OAI repository on your own Eurecom GitLab account. It just eats up space on our servers.
-   - You can fork onto another hosting system. But we will NOT accept a merge request from a forked repository.
+2. Register on [Eurecom GitLab Server](https://gitlab.eurecom.fr/users/sign_up)
+   if you do not have any.
+   - We recommend that you register with a professional or student email address.
+   - If your email domain (`@domain.com`) is not whitelisted, please contact us
+     (mailto:contact@openairinterface.org).
+   - Eurecom GitLab does NOT accept public email domains.
+3. Provide the OAI team with the **username** of this account to
+   (mailto:contact@openairinterface.org) ; we will give you the developer
+   rights on this repository.
+4. The contributing policies are described in the [corresponding documentation
+   page](doc/code-style-contrib.md).
+   - PLEASE DO NOT FORK the OAI repository on your own Eurecom GitLab account.
+     It just eats up space on our servers.
+   - You can fork onto another hosting system. But we will NOT accept a merge
+     request from a forked repository.
       * This decision was made for the license reasons.
       * The Continuous Integration will reject your merge request.
-   - All merge requests SHALL have `develop` branch as target branch.
-
-## Coding Styles ##
-
-There are described [here](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/guidelines/guidelines-home)
 
-## License ##
+# License #
 
-By contributing to OpenAirInterface, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.
+By contributing to OpenAirInterface, you agree that your contributions will be
+licensed under the license described in the file [`LICENSE`](./LICENSE) in the
+root directory of this source tree.

NOTICE.md

@@ -4,15 +4,6 @@ For more details of the license, refer to [LICENSE](LICENSE) file in the same di
 
 However, the source code also contains third party software that is acknowledged here for reference.
 
-## Credits for LFDS user space source code located in folder openair2/UTILS/LFDS/ ##
-
-See on [liblfds website](https://liblfds.org/) the license section.
-
-<pre>
-"There is no license. You are free to use this software in any way, for any purpose. Go forth and create wealth!
-If however for legal reasons a licence is required, the license of your choice will be granted."
-</pre>
-
 ## Credits for source code common/utils/collection/queue.h: ##
 
 The Regents of the University of California: BSD 3-Clause Licence.

README.md

@@ -4,8 +4,15 @@
 
 <p align="center">
     <a href="https://gitlab.eurecom.fr/oai/openairinterface5g/-/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-OAI--Public--V1.1-blue" alt="License"></a>
-    <a href="https://releases.ubuntu.com/18.04/"><img src="https://img.shields.io/badge/OS-Ubuntu18-Green" alt="Supported OS"></a>
-    <a href="https://www.redhat.com/en/enterprise-linux-8"><img src="https://img.shields.io/badge/OS-RHEL8-Green" alt="Supported OS"></a>
+    <a href="https://releases.ubuntu.com/20.04/"><img src="https://img.shields.io/badge/OS-Ubuntu20-Green" alt="Supported OS Ubuntu 20"></a>
+    <a href="https://releases.ubuntu.com/22.04/"><img src="https://img.shields.io/badge/OS-Ubuntu22-Green" alt="Supported OS Ubuntu 22"></a>
+    <a href="https://releases.ubuntu.com/24.04/"><img src="https://img.shields.io/badge/OS-Ubuntu24-Green" alt="Supported OS Ubuntu 24"></a>
+    <a href="https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux"><img src="https://img.shields.io/badge/OS-RHEL9-Green" alt="Supported OS RELH9"></a>
+    <a href="https://getfedora.org/en/workstation/"><img src="https://img.shields.io/badge/OS-Fedore41-Green" alt="Supported OS Fedora 41"></a>
+</p>
+
+<p align="center">
+    <a href="https://gitlab.eurecom.fr/oai/openairinterface5g/-/releases"><img alt="GitLab Release (custom instance)" src="https://img.shields.io/gitlab/v/release/oai/openairinterface5g?gitlab_url=https%3A%2F%2Fgitlab.eurecom.fr&include_prereleases&sort=semver"></a>
 </p>
 
 <p align="center">
@@ -13,10 +20,11 @@
 </p>
 
 <p align="center">
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-enb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-enb?label=eNB%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-lte-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-lte-ue?label=LTE-UE%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-gnb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-gnb?label=gNB%20docker%20pulls"></a>
-  <a href="https://hub.docker.com/r/rdefosseoai/oai-nr-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/rdefosseoai/oai-nr-ue?label=NR-UE%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-gnb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-gnb?label=gNB%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-nr-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-nr-ue?label=NR-UE%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-enb"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-enb?label=eNB%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-lte-ue"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-lte-ue?label=LTE-UE%20docker%20pulls"></a>
+  <a href="https://hub.docker.com/r/oaisoftwarealliance/oai-nr-cuup"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/oaisoftwarealliance/oai-nr-cuup?label=NR-CUUP%20docker%20pulls"></a>
 </p>
 
 # OpenAirInterface License #
@@ -32,61 +40,58 @@ Please see [NOTICE](NOTICE.md) file for third party software that is included in
 
 # Where to Start #
 
+ *  [General overview of documentation](./doc/README.md)
  *  [The implemented features](./doc/FEATURE_SET.md)
+ *  [System Requirements for Using OAI Stack](./doc/system_requirements.md)
  *  [How to build](./doc/BUILD.md)
  *  [How to run the modems](./doc/RUNMODEM.md)
 
+Not all information is available in a central place, and information for
+specific sub-systems might be available in the corresponding sub-directories.
+To find all READMEs, this command might be handy:
+
+```
+find . -iname "readme*"
+```
+
 # RAN repository structure #
 
 The OpenAirInterface (OAI) software is composed of the following parts: 
 
-<pre>
+```
 openairinterface5g
+├── charts
 ├── ci-scripts        : Meta-scripts used by the OSA CI process. Contains also configuration files used day-to-day by CI.
+├── CMakeLists.txt    : Top-level CMakeLists.txt for building
 ├── cmake_targets     : Build utilities to compile (simulation, emulation and real-time platforms), and generated build files.
-├── common            : Some common OAI utilities, other tools can be found at openair2/UTILS.
-├── doc               : Contains an up-to-date feature set list and starting tutorials.
-├── executables       : Top-level executable source files.
-├── LICENSE           : License file.
+├── common            : Some common OAI utilities, some other tools can be found at openair2/UTILS.
+├── doc               : Documentation
+├── docker            : Dockerfiles to build for Ubuntu and RHEL
+├── executables       : Top-level executable source files (gNB, eNB, ...)
 ├── maketags          : Script to generate emacs tags.
-├── nfapi             : Contains the NFAPI code. A local Readme file provides more details.
-├── openair1          : 3GPP LTE Rel-10/12 PHY layer / 3GPP NR Rel-15 layer. A local Readme file provides more details.
-│   ├── PHY
-│   ├── SCHED
-│   ├── SCHED_NBIOT
-│   ├── SCHED_NR
-│   ├── SCHED_NR_UE
-│   ├── SCHED_UE
-│   └── SIMULATION    : PHY RF simulation.
-├── openair2          : 3GPP LTE Rel-10 RLC/MAC/PDCP/RRC/X2AP + LTE Rel-14 M2AP implementation. Also 3GPP NR Rel-15 RLC/MAC/PDCP/RRC/X2AP.
-│   ├── COMMON
-│   ├── DOCS
-│   ├── ENB_APP
-│   ├── F1AP
-│   ├── GNB_APP
-│   ├── LAYER2/RLC/   : with the following subdirectories: UM_v9.3.0, TM_v9.3.0, and AM_v9.3.0.
-│   ├── LAYER2/PDCP/PDCP_v10.1.0
-│   ├── M2AP
-│   ├── MCE_APP
-│   ├── NETWORK_DRIVER
-│   ├── NR_PHY_INTERFACE
-│   ├── NR_UE_PHY_INTERFACE
-│   ├── PHY_INTERFACE
-│   ├── RRC
-│   ├── UTIL
-│   └── X2AP
-├── openair3          : 3GPP LTE Rel10 for S1AP, NAS GTPV1-U for both ENB and UE.
-│   ├── COMMON
-│   ├── DOCS
-│   ├── GTPV1-U
-│   ├── M3AP
-│   ├── MME_APP
-│   ├── NAS
-│   ├── S1AP
-│   ├── SCTP
-│   ├── SECU
-│   ├── TEST
-│   ├── UDP
-│   └── UTILS
-└── targets           : Top-level wrappers for unitary simulation for PHY channels, system-level emulation (eNB-UE with and without S1), and realtime eNB and UE and RRH GW.
-</pre>
+├── nfapi             : (n)FAPI code for MAC-PHY interface
+├── openair1          : Layer 1 (3GPP LTE Rel-10/12 PHY, NR Rel-15 PHY)
+├── openair2          : Layer 2 (3GPP LTE Rel-10 MAC/RLC/PDCP/RRC/X2AP, LTE Rel-14 M2AP, NR Rel-15+ MAC/RLC/PDCP/SDAP/RRC/X2AP/F1AP/E1AP), E2AP
+├── openair3          : Layer 3 (3GPP LTE Rel-10 S1AP/GTP, NR Rel-15 NGAP/GTP)
+├── openshift         : OpenShift helm charts for some deployment options of OAI
+├── radio             : Drivers for various radios such as USRP, AW2S, RFsim, 7.2 FHI, ...
+├── targets           : Some configuration files; only historical relevance, and might be deleted in the future
+└── tools             : Tools for use by the developers/ci machines: code analysis and formatting
+```
+
+# How to get support from the OAI Community # 
+
+You can ask your question on the [mailing lists](https://gitlab.eurecom.fr/oai/openairinterface5g/-/wikis/MailingList).
+
+Your email should contain below information:
+
+- A clear subject in your email.
+- For all the queries there should be [Query\] in the subject of the email and for problems there should be [Problem\].
+- In case of a problem, add a small description.
+- Do not share any photos unless you want to share a diagram.
+- OAI gNB/DU/CU/CU-CP/CU-UP configuration file in `.conf` format only.
+- Logs of OAI gNB/DU/CU/CU-CP/CU-UP in `.log` or `.txt` format only.
+- In case your question is related to performance, include a small description of the machine (Operating System, Kernel version, CPU, RAM and networking card) and diagram of your testing environment.
+- Known/open issues are present on [GitLab](https://gitlab.eurecom.fr/oai/openairinterface5g/-/issues), so keep checking.
+
+Always remember a structured email will help us understand your issues quickly.

charts/physims/Chart.yaml

@@ -16,7 +16,7 @@ icon: http://www.openairinterface.org/wp-content/uploads/2015/06/cropped-oai_fin
 
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
-version: 0.1.1
+version: 1.0.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application.

charts/physims/charts/dlsim.100rb+tm2/Chart.yaml

+apiVersion: v1
+name: oai-dlsim-100rb-tm2
+description: A Helm subchart for dlsim network function ("100rb+tm2" tests)
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+icon: http://www.openairinterface.org/wp-content/uploads/2015/06/cropped-oai_final_logo.png
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+version: 0.1.1
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application.
+appVersion: v1
+
+keywords:
+  - Physical Simulator
+  - dlsim
+  - RAN
+  - 4G
+
+sources:
+  - https://gitlab.eurecom.fr/oai/openairinterface5g
+
+maintainers:
+  - name:  OPENAIRINTERFACE
+    email: contact@openairinterface.org

charts/physims/charts/dlsim.100rb+tm2/templates/_helpers.tpl

+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "oai-dlsim-100rb-tm2.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "oai-dlsim-100rb-tm2.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "oai-dlsim-100rb-tm2.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "oai-dlsim-100rb-tm2.labels" -}}
+helm.sh/chart: {{ include "oai-dlsim-100rb-tm2.chart" . }}
+{{ include "oai-dlsim-100rb-tm2.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}
+
+{{/*
+Selector labels
+*/}}
+{{- define "oai-dlsim-100rb-tm2.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "oai-dlsim-100rb-tm2.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "oai-dlsim-100rb-tm2.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+    {{ default (include "oai-dlsim-100rb-tm2.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+    {{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}

charts/physims/charts/dlsim.100rb+tm2/templates/job.yaml

+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ .Chart.Name }}
+spec:
+  template:
+    metadata:
+      labels:
+        app: physim
+    spec:
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+    {{- if .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      containers:
+      - name: physim
+        image: "{{ .Values.global.image.repository }}:{{ .Values.global.image.version }}"
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        {{- if .Values.global.resources.define}}
+        resources:
+          requests:
+            cpu: {{ .Values.global.resources.requests.cpu | quote }}
+        {{- end}}
+        securityContext:
+          {{- toYaml .Values.securityContext | nindent 12 }}
+        env:
+        - name: OPENAIR_DIR
+          value: /opt/oai-physim
+        command: ["/bin/sh", "-c"]
+        args:
+        - >
+          cmake_targets/autotests/run_exec_autotests.bash -g "dlsim.100rb+tm2" -d bin/ &&
+          echo "FINISHED" && sleep infinity
+      dnsPolicy: ClusterFirst
+      restartPolicy: Never
+      schedulerName: default-scheduler
+      serviceAccountName: {{ .Values.global.serviceAccountName }}
+      terminationGracePeriodSeconds: 30
+      {{- if .Values.global.nodeSelector}}
+      nodeSelector:
+         {{- toYaml .Values.global.nodeSelector | nindent 12 }}
+      {{- end }}
+      {{- if .Values.global.nodeName}}
+      nodeName: {{ .Values.global.nodeName.dlsim100rbtm2 }}
+      {{- end }}

charts/physims/charts/dlsim.100rb+tm2/values.yaml

+# Default values for oai-dlsim-100rb+tm2
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  # pullPolicy: IfNotPresent or Never or Always
+  pullPolicy: Always
+
+imagePullSecrets: []
+
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: "oai-dlsim-100rb-tm2"
+
+podSecurityContext:
+  runAsUser: 0
+  runAsGroup: 0
+
+securityContext:
+  privileged: false
+
+resources: {}
+  # We usually recommend not to specify default resources and to leave this as a conscious
+  # choice for the user. This also increases chances charts run on environments with little
+  # resources, such as Minikube. If you do want to specify resources, uncomment the following
+  # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
+  # limits:
+  #   cpu: 100m
+  #   memory: 128Mi
+  # requests:
+  #   cpu: 100m
+  #   memory: 128Mi
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}

charts/physims/charts/dlsim.basic/Chart.yaml

+apiVersion: v1
+name: oai-dlsim-basic
+description: A Helm subchart for dlsim network function ("basic" tests)
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+icon: http://www.openairinterface.org/wp-content/uploads/2015/06/cropped-oai_final_logo.png
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+version: 0.1.1
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application.
+appVersion: v1
+
+keywords:
+  - Physical Simulator
+  - dlsim
+  - RAN
+  - 4G
+
+sources:
+  - https://gitlab.eurecom.fr/oai/openairinterface5g
+
+maintainers:
+  - name:  OPENAIRINTERFACE
+    email: contact@openairinterface.org

charts/physims/charts/dlsim.basic/templates/_helpers.tpl

+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "oai-dlsim-basic.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "oai-dlsim-basic.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "oai-dlsim-basic.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Common labels
+*/}}
+{{- define "oai-dlsim-basic.labels" -}}
+helm.sh/chart: {{ include "oai-dlsim-basic.chart" . }}
+{{ include "oai-dlsim-basic.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}
+
+{{/*
+Selector labels
+*/}}
+{{- define "oai-dlsim-basic.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "oai-dlsim-basic.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "oai-dlsim-basic.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+    {{ default (include "oai-dlsim-basic.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+    {{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}

charts/physims/charts/dlsim.basic/templates/job.yaml

+apiVersion: batch/v1
+kind: Job
+metadata:
+  name: {{ .Chart.Name }}    
+spec:
+  template:
+    metadata:
+      labels:
+         app: physim
+    spec:
+      securityContext:
+        {{- toYaml .Values.podSecurityContext | nindent 8 }}
+    {{- if .Values.imagePullSecrets }}
+      imagePullSecrets:
+        {{- toYaml . | nindent 8 }}
+    {{- end }}
+      containers:
+      - name: physim
+        image: "{{ .Values.global.image.repository }}:{{ .Values.global.image.version }}"
+        imagePullPolicy: {{ .Values.image.pullPolicy }}
+        {{- if .Values.global.resources.define}}
+        resources:
+          requests:
+            cpu: {{ .Values.global.resources.requests.cpu | quote }}
+        {{- end}}
+        securityContext:
+          {{- toYaml .Values.securityContext | nindent 12 }}
+        env:
+        - name: OPENAIR_DIR
+          value: /opt/oai-physim
+        command: ["/bin/sh", "-c"]
+        args:
+        - >
+          cmake_targets/autotests/run_exec_autotests.bash -g "dlsim.basic" -d bin/ &&
+          echo "FINISHED" && sleep infinity
+      dnsPolicy: ClusterFirst
+      restartPolicy: Never
+      schedulerName: default-scheduler
+      serviceAccountName: {{ .Values.global.serviceAccountName }} 
+      terminationGracePeriodSeconds: 30
+      {{- if .Values.global.nodeSelector}}
+      nodeSelector:
+         {{- toYaml .Values.global.nodeSelector | nindent 12 }}
+      {{- end }}
+      {{- if .Values.global.nodeName}}
+      nodeName: {{ .Values.global.nodeName.dlsimbasic }}
+      {{- end }}

charts/physims/charts/dlsim.basic/values.yaml

+# Default values for oai-dlsim-basic
+# This is a YAML-formatted file.
+# Declare variables to be passed into your templates.
+
+replicaCount: 1
+
+image:
+  # pullPolicy: IfNotPresent or Never or Always
+  pullPolicy: Always
+
+imagePullSecrets: []
+
+nameOverride: ""
+fullnameOverride: ""
+
+serviceAccount:
+  # Specifies whether a service account should be created
+  create: true
+  # Annotations to add to the service account
+  annotations: {}
+  # The name of the service account to use.
+  # If not set and create is true, a name is generated using the fullname template
+  name: "oai-dlsim-basic"
+
+podSecurityContext:
+  runAsUser: 0
+  runAsGroup: 0
+
+securityContext:
+  privileged: false
+
+resources:
+   limits:
+     cpu: 100m
+     memory: 128Mi
+   requests:
+     cpu: 100m
+     memory: 128Mi
+
+nodeSelector: {}
+
+tolerations: []
+
+affinity: {}