How episci/oai-lte-5g-multi-ue-proxy works
Main Components
• Proxy Core: Represent the central proxy application (built from the “src” and build outputs, e.g., proxy.cc and related files) which handles mode-specific logic.
• UE Modules: Illustrate the multiple UEs (LTE and NR components) that communicate via sockets. Emphasize that multiple UEs can be launched (some even from remote hosts).
• eNB/gNB: Include the network nodes:
• LTE eNB for LTE mode.
• gNB for NR/NSA/SA modes.
• nfapi module (under open-nFAPI/nfapi): responsible for interfacing with the lower layers.
• pnf (physical network function) and its support modules, including simulated versions (pnf_sim).
• vnf (virtual network function) and corresponding simulation support (vnf_sim).
• Supporting Modules: Include other libraries/utilities like sim_common which provide shared components (e.g., queuing, logging).
• External Dependencies: Optionally show the dependency on the OpenAirInterface (OAI) repository and its core processes (e.g., lte-softmodem, nr-softmodem, etc.), as well as external modules like EPC or 5GCN (especially in the context of EPC/5GCN support mentioned in the README).
Relationships and Data Flow
• Within the proxy, indicate interactions with dedicated nFAPI layers where components such as nfapi, pnf, and vnf provide the abstraction to handle protocol details and simulate the PHY interactions.
• If possible, note the presence of test scripts (proxy_testscript.py) that simulate various UE scenarios and invoke different modes (LTE, NSA, SA). This can be annotated as “Testing Harness” influencing the data flow.
Architectural Patterns and Design Principles
• Modularity: The project is highly modularized. Present its separation into different modules (nfapi, pnf, vnf, common utilities) to enable extensibility and isolated testing.
• Layered Communication: Illustrate a layered communication stack – from the application level (handling socket communication and logging) down to lower-level nFAPI interactions that ultimately simulate the PHY layer.
Relevant Technologies and Frameworks
• Socket communication is used throughout (from UEs to the proxy and to the eNB/gNB).
• Testing components (integration_tests, unit tests with cunit) should be mentioned as part of the verification strategy.
• Docker files indicate some containerized builds, so if needed, include a note for deployment aspects.