openairinterface5g

Files

T

Robert Schmidt 918ea49686 Merge remote-tracking branch 'origin/phy_simulators_ctest' into integration_2025_w20 (!3379 )

Add physim tests into ctest framework

Convert physim testcases listed in
cmake_targets/autotests/test_case_list.xml into ctest. Note: Tests for
dlsim_tm4 are excluded, due to compilation issues.

CTest evaluates success based on return code: '0' = pass, non-zero =
fail. For some simulators, the return code is non-zero even when the
test is successful (as indicated by success messages in the test logs).
For some simulators, the return code is always '0'. This inconsistency
has been address in the first two commits of this MR.

To build and execute these tests:

- using cmake

    cd openairinterface5g
    mkdir build && cd build # you can also do that in cmake_targets/ran_build/build
    cmake .. -GNinja -DENABLE_PHYSIM_TESTS=ON && ninja tests
    ctest

- using build_oai: physim-related ctests are activated when PHY
  simulators are built (use build_oai with '-P' or '--phy_simulators'
  option)

    cd openairinterface5g/cmake_targets
    ./build_oai --ninja --phy_simulators
    cd ran_build/build
    ctest

Link to newly created 4g and 5g RAN-Physim-Cluster pipelines:

- RAN-Physim-Cluster-4G: https://jenkins-oai.eurecom.fr/job/RAN-Physim-Cluster-4G/
- RAN-Physim-Cluster-5G: https://jenkins-oai.eurecom.fr/job/RAN-Physim-Cluster-5G/

2025-05-17 12:05:27 +02:00

DOC

feat(nrLDPC_encoder): remove _optim and _optim8seg

2025-05-13 07:32:36 +00:00

nrLDPC_coding

fix(nrLDPC_coding_interface): mistaken line forgotten in documentation

2025-05-13 14:08:33 +00:00

nrLDPC_decoder

feat(cnProc_gen_BG1_128): Put back small change in 128-bit SIMD code generator for LDPC decoder (cnProc).

2025-05-13 14:08:33 +00:00

nrLDPC_decoder_LYC

fix(nrLDPC_decoder): Rename E in Kprime in segment decoder parameters to comply with standard naming

2025-01-10 08:54:37 +00:00

nrLDPC_encoder

fix(nrLDPC_coding_segment_encoder): address review

2025-05-13 14:08:33 +00:00

nrPolar_tools

remove dead code and a wrong comment

2025-04-28 11:59:17 +02:00

nrSmallBlock

rework PUCCH codec with c16_t type, rewrite large parts of functions to make readable code. Not fixed parts that are using SIMD. No change, the code is still same block by block (variable visibility narrowed, declaration can be shifted)

2024-01-04 10:21:15 +01:00

TESTBENCH

Merge remote-tracking branch 'origin/phy_simulators_ctest' into integration_2025_w20 (!3379 )

2025-05-17 12:05:27 +02:00

tests

CI: adjust tested SNR for nr_pucchsim

2025-05-16 16:38:54 +02:00

3gpplte_sse.c

remove MMX instruction usage in polar decode

2025-01-24 15:29:28 +01:00

3gpplte_turbo_decoder_avx2_16bit.c

Remove unused PHY_MEX compile option

2025-01-23 14:11:13 +01:00

3gpplte_turbo_decoder_sse_8bit.c

Remove unused PHY_MEX compile option

2025-01-23 14:11:13 +01:00

3gpplte_turbo_decoder_sse_16bit.c

Remove unused PHY_MEX compile option

2025-01-23 14:11:13 +01:00

3gpplte_turbo_decoder_sse.c

remove calls to clear SIMD registers, that was a historical issue

2025-01-14 10:06:06 +01:00

3gpplte_turbo_decoder.c

first-fix-rrc-mac-interface

2022-12-02 16:47:21 +01:00

3gpplte.c

CPPCHECK fixes for printf issues

2023-06-01 12:07:26 +02:00

ccoding_byte_lte.c

remove a race condition in viberti_lte and a useless global table

2025-01-14 10:07:30 +01:00

ccoding_byte.c

fix most of doxygen warnings and errors

2023-10-26 16:47:19 +02:00

CMakeLists.txt

Merge remote-tracking branch 'origin/phy_simulators_ctest' into integration_2025_w20 (!3379 )

2025-05-17 12:05:27 +02:00

coding_defs.h

remove part of code using _m64 type (so old mmx instructions)

2025-01-14 10:07:59 +01:00

coding_extern.h

fix a lot of file mode

2019-01-07 16:22:28 +01:00

coding_load.c

fix most of doxygen warnings and errors

2023-10-26 16:47:19 +02:00

crc_byte.c

First-level of support for new aarch64 machines

2023-09-13 17:19:20 +02:00

crc.h

First-level of support for new aarch64 machines

2023-09-13 17:19:20 +02:00

crcext.h

First-level of support for new aarch64 machines

2023-09-13 17:19:20 +02:00

defs_NB_IoT.h

code cleanup, no feature

2021-10-24 14:47:24 +02:00

lte_interleaver_inline.h

fix a lot of file mode

2019-01-07 16:22:28 +01:00

lte_rate_matching.c

Fix compilation errors due to -Werror

2023-06-08 19:15:24 +02:00

lte_segmentation.c

CPPCHECK fixes for printf issues

2023-06-01 12:07:26 +02:00

lte_tf.m

fix a lot of file mode

2019-01-07 16:22:28 +01:00

Makefile

fix a lot of file mode

2019-01-07 16:22:28 +01:00

Makefile.arm

fix a lot of file mode

2019-01-07 16:22:28 +01:00

nr_segmentation.c

AVX512 modifications for LDPC encoding: interleaving, ZC384 BG1, output formatting for encoder, segmentation (memcpy)

2025-05-13 14:08:33 +00:00

nrLDPC_defs.h

fix(nrLDPC_coding_segment_encoder): address review

2025-05-13 14:08:33 +00:00

nrLDPC_extern.h

move byte2m128i in a more logical place

2025-01-30 17:14:10 +01:00

nrLDPC_load.c

feat(nrLDPC_coding): Transform segment coding libraries into slot coding libraries by statically linking the adaptation layer and the segment coding libraries

2025-02-05 11:22:46 +00:00

README.txt

fix a lot of file mode

2019-01-07 16:22:28 +01:00

types.h

missing .h file for intel crc

2021-11-01 17:57:04 +01:00

viterbi_lte.c

remove part of code using _m64 type (so old mmx instructions)

2025-01-14 10:07:59 +01:00

viterbi.c

remove calls to clear SIMD registers, that was a historical issue

2025-01-14 10:06:06 +01:00

README.txt

PHY/CODING
----------


This directory contains the transport channel coding/decoding functions for both OpenAirInterface and a subset of LTE/WiMAX/WIFI MODEMS.
They can only be compiled on x86 platforms (at least sse,sse2 are required).

Files
------


crc_byte.c                     : 3GPP CRC routines (8,16,24 bit, LTE - 36-212 and WCDMA 25-212)
ccoding_byte.c                 : WIFI/WIMAX rate 1/2 convolutional code
ccoding_byte_lte.c             : 3GPP LTE rate 1/3 tail-biting convolutional code with CRC embedding
3gpplte.c                      : 3GPP LTE rate 1/3 turbo code
3gpp_turbo_decoder.c           : 3GPP/LTE turbo decoder (non-optimized)
3gpplte_turbo_decoder_sse.c    : 3GPP/LTE turbo decoder (optimized for SSE2/SSE3)
lte_interleaver.h              : 3GPP/LTE interleaver coefficient table (from 3GPP 36-212)
lte_interleaver_inline.h       : 3GPP/LTE Interleaver inline functions (from 3GPP 36-212)
lte_tf.m                       : 3GPP/LTE transport format size calculator
rate_matching.c                : OpenAirInterface pseudo-random rate matching
viterbi.c                      : WIFI/WIMAX rate 1/2 Viterbi decoder (non-optimized and optimized versions)
viterbi_lte.c                  : 3GPP LTE Viterbi decoder (SIMD optimized)
lte_rate_matching.c            : 3GPP/LTE Rate (de)matching and sub-block (de)interleaving routines (strict compliance with 3GPP 36-212, Release 8, 2009-03)
Makefile		       : Generates simple unitary tests for the three coding formats.  Note this doesn't do a performance evaluation.


Directories
-----------

TESTBENCH                      : Testbench for channel coding/decoding



Use of unitary tests
--------------------

Three tests can be compiled with "make".  They are standalone and do not require the rest of openair1.
They only test the following files:

crc_byte.c
ccoding_byte.c
ccdoing_byte_lte.c
3gpp_turbo_decoder_sse.c
3gpplte.c
viterbi.c
viterbi_lte.c

After "make", you should have three executables, turbo_test, rate13cc_test and rate12cc_test which should 
all have executed and printed proof of correct execution (at least for the default block lengths).  Further 
tests should be performed with the performance tests in TESTBENCH, which require the rest of openair1.