Files
openairinterface5g/openair1/PHY/CODING
Jaroslava Fiedlerova 5adfeb80c3 Merge remote-tracking branch 'origin/make-all-targets-compile' into integration_2025_w40 (!3665)
Make all targets compile

This MR enables us to compile all targets, and does that in one CI test. This
closes #726. Now, this should work:

cd ~/openairinterface5g
mkdir build && cd build
cmake .. -GNinja && ninja

To achieve this, I did the following:
- some targets have been fixed (warnings, errors)
- some targets have been removed when they did not seem to serve a good purpose
  (e.g., an almost empty test)
- some targets have been commented (e.g., LTE simulators, some unitary tests)
  which we maybe want to revive in the future
- some targets built when just building with ninja, but not all. For instance,
  telnetsrv_enb would typically build, but it was missing a dependency. Doing
  cmake .. -GNinja && ninja telnetsrv_enb would show this (in develop)

To help with the last bullet point, there is a script compile_targets.sh that
can compile targets independently (and in parallel, to not wait for ages) to
show that targets compile properly compile-targets.patch.

In almost all cases, the problem is that a specific module uses the logging
module, which depends on T, which needs to dynamically create headers. The way
to do this is to have a dependency, and many targets use generate_T or {T_LIB}
({} intentional: T might be absent, so then it evaluates to nothing). However,
not all do this, and those that depend on T actually don't depend on T, but on
the logging module, which in turn depends on T. So in many places, a simple
dependency onto log_headers fixes this problem, and generate_T or {T_LIB}
simplifies the dependency (but not always). The commits should have more info.

Note that at least the targets in FlexRIC do not all compile, at least in the
configuration that we use in docker/Dockerfile.build.ubuntu. So for the latter,
we cannot build with a simple ninja, but FlexRIC seems to be the only one that
does not compile. Since FlexRIC is a separate repository, that needs to be
addressed in the corresponding repository.
2025-10-01 14:48:45 +02:00
..
2025-08-11 08:38:06 +00:00
2025-09-29 09:04:02 +02:00
2019-01-07 16:22:28 +01:00
2021-10-24 14:47:24 +02:00
2019-01-07 16:22:28 +01:00
2019-01-07 16:22:28 +01:00
2019-01-07 16:22:28 +01:00
2025-06-03 17:03:17 +02:00
2019-01-07 16:22:28 +01:00
2021-11-01 17:57:04 +01:00

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.