feat(ldpc-decoding-module-interface-rework): drafts of framework ,first dummy...

feat(ldpc-decoding-module-interface-rework): drafts of framework ,first dummy module and usage in nr_ulsim added. compiles but fails at linking for reasons apparently unrelated to the feature (missing linker include library flag for lapack, test on belostome.sboai.cs.eurecom.fr RHEL8 laptop).

CMakeLists.txt

@@ -861,10 +861,18 @@ add_library(ldpc_cl MODULE ${PHY_LDPC_CL_SRC} )
 target_link_libraries(ldpc_cl OpenCL)
 add_dependencies(ldpc_cl nrLDPC_decoder_kernels_CL)
 
+set(PHY_NR_ULSCH_DECODING_DEMO_SRC
+  ${OPENAIR1_DIR}/PHY/CODING/nr_ulsch_decoding_interface_demo.c
+)
+
 set(PHY_NR_CODINGIF
   ${OPENAIR1_DIR}/PHY/CODING/nrLDPC_load.c
 )
 
+set(PHY_NR_ULSCH_DECODINGIF
+  ${OPENAIR1_DIR}/PHY/CODING/nr_ulsch_decoding_interface_load.c
+)
+
 ##############################################
 # Base CUDA setting
 ##############################################
@@ -885,6 +893,7 @@ add_library(coding MODULE ${PHY_TURBOSRC} )
 
 add_library(dfts MODULE ${OPENAIR1_DIR}/PHY/TOOLS/oai_dfts.c ${OPENAIR1_DIR}/PHY/TOOLS/oai_dfts_neon.c)
 
+add_library(_nr_ulsch_decoding_interface_demo MODULE ${PHY_NR_ULSCH_DECODING_DEMO_SRC})
 
 set(PHY_SRC_COMMON
   ${OPENAIR1_DIR}/PHY/LTE_TRANSPORT/dci_tools_common.c
@@ -1074,6 +1083,7 @@ set(PHY_SRC_UE
   ${PHY_POLARSRC}
   ${PHY_SMALLBLOCKSRC}
   ${PHY_NR_CODINGIF}
+  ${PHY_NR_ULSCH_DECODINGIF}
   ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/pucch_rx.c
   ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/srs_rx.c
   ${OPENAIR1_DIR}/PHY/NR_TRANSPORT/nr_uci_tools_common.c
@@ -2311,6 +2321,7 @@ add_executable(nr_ulsim
 if (ENABLE_LDPC_T2)
   add_dependencies(nr_ulsim ldpc_t2)
 endif()
+add_dependencies(nr_ulsim _nr_ulsch_decoding_interface_demo)
 
 target_link_libraries(nr_ulsim PRIVATE
   -Wl,--start-group UTIL SIMU SIMU_ETH PHY_COMMON PHY_NR_COMMON PHY_NR PHY_NR_UE SCHED_NR_LIB SCHED_NR_UE_LIB MAC_UE_NR MAC_NR_COMMON nr_rrc CONFIG_LIB L2_NR HASHTABLE x2ap SECURITY ngap -lz -Wl,--end-group
@@ -2377,7 +2388,7 @@ if (${T_TRACER})
         PHY_COMMON PHY PHY_UE PHY_NR PHY_NR_COMMON PHY_NR_UE PHY_RU PHY_MEX
         L2 L2_LTE L2_NR L2_LTE_NR L2_UE NR_L2_UE L2_UE_LTE_NR MAC_NR_COMMON MAC_UE_NR ngap
         CN_UTILS GTPV1U SCTP_CLIENT MME_APP LIB_NAS_UE NB_IoT SIMU SIMU_ETH OPENAIR0_LIB
-        ldpc_orig ldpc_optim ldpc_optim8seg ldpc_t2 ldpc_cl ldpc_cuda ldpc dfts config_internals)
+        ldpc_orig ldpc_optim ldpc_optim8seg ldpc_t2 ldpc_cl ldpc_cuda ldpc _nr_ulsch_decoding_interface_demo dfts config_internals)
     if (TARGET ${i})
       add_dependencies(${i} generate_T)
     endif()

openair1/PHY/CODING/nr_ulsch_decoding_interface.h

+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1  (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ *      contact@openairinterface.org
+ */
+
+#include "PHY/defs_gNB.h"
+
+#ifndef __NR_ULSCH_DECODING_INTERFACE__H__
+#define __NR_ULSCH_DECODING_INTERFACE__H__
+
+typedef int32_t(nr_ulsch_decoding_init_t)(void);
+typedef int32_t(nr_ulsch_decoding_shutdown_t)(void);
+/**
+ * \brief slot decoding function interface
+ * \param gNB PHY layers variables of gNB
+ * \param frame_parms informations on the frame
+ * \param frame_rx RX frame index
+ * \param slot_rx RX slot index
+ * \param G arrays of G
+ */
+typedef int32_t(nr_ulsch_decoding_decoder_t)(PHY_VARS_gNB *gNB, NR_DL_FRAME_PARMS *frame_parms, int frame_rx, int slot_rx, uint32_t *G);
+
+typedef struct nr_ulsch_decoding_interface_s {
+  nr_ulsch_decoding_init_t *nr_ulsch_decoding_init;
+  nr_ulsch_decoding_shutdown_t *nr_ulsch_decoding_shutdown;
+  nr_ulsch_decoding_decoder_t *nr_ulsch_decoding_decoder;
+} nr_ulsch_decoding_interface_t;
+
+int load_nr_ulsch_decoding_interface(char *version, nr_ulsch_decoding_interface_t *interface);
+int free_nr_ulsch_decoding_interface(nr_ulsch_decoding_interface_t *interface);
+
+//TODO replace the global structure below
+// Global var to limit the rework of the dirty legacy code
+extern nr_ulsch_decoding_interface_t nr_ulsch_decoding_interface;
+
+#endif

openair1/PHY/CODING/nr_ulsch_decoding_interface_load.c

+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1  (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ *      contact@openairinterface.org
+ */
+
+/*! \file nrLDPC_load.c
+ * \brief: load library implementing coding/decoding algorithms
+ * \author Francois TABURET
+ * \date 2020
+ * \version 0.1
+ * \company NOKIA BellLabs France
+ * \email: francois.taburet@nokia-bell-labs.com
+ * \note
+ * \warning
+ */
+#define _GNU_SOURCE 
+#include <sys/types.h>
+#include <stdlib.h>
+#include <malloc.h>
+#include "assertions.h"
+#include "common/utils/LOG/log.h"
+#include "PHY/CODING/nrLDPC_extern.h"
+#include "common/config/config_userapi.h"
+#include "common/utils/load_module_shlib.h"
+#include "PHY/CODING/nr_ulsch_decoding_interface.h"
+
+/* arguments used when called from phy simulators exec's which do not use the config module */
+/* arg is used to initialize the config module so that the loader works as expected */
+char *arguments_phy_simulators[64]={"ldpctest",NULL};
+
+int load_nr_ulsch_decoding_interface(char *version, nr_ulsch_decoding_interface_t *itf)
+{
+  char *ptr = (char *)config_get_if();
+  char libname[64] = "nr_ulsch_decoding";
+
+  if (ptr == NULL) { // phy simulators, config module possibly not loaded
+    uniqCfg = load_configmodule(1, arguments_phy_simulators, CONFIG_ENABLECMDLINEONLY);
+    logInit();
+  }
+  /* function description array, to be used when loading the encoding/decoding shared lib */
+  loader_shlibfunc_t shlib_fdesc[] = {{.fname = "nr_ulsch_decoding_init"},
+                                      {.fname = "nr_ulsch_decoding_shutdown"},
+                                      {.fname = "nr_ulsch_decoding_decoder"}};
+  int ret;
+  ret = load_module_version_shlib(libname, version, shlib_fdesc, sizeofArray(shlib_fdesc), NULL);
+  AssertFatal((ret >= 0), "Error loading NR ULSCH decoding module");
+  itf->nr_ulsch_decoding_init = (nr_ulsch_decoding_init_t *)shlib_fdesc[0].fptr;
+  itf->nr_ulsch_decoding_shutdown = (nr_ulsch_decoding_shutdown_t *)shlib_fdesc[1].fptr;
+  itf->nr_ulsch_decoding_decoder = (nr_ulsch_decoding_decoder_t *)shlib_fdesc[2].fptr;
+
+  AssertFatal(itf->nr_ulsch_decoding_init() == 0, "error starting LDPC library %s %s\n", libname, version);
+
+  return 0;
+}
+
+int free_nr_ulsch_decoding_interface(nr_ulsch_decoding_interface_t *interface)
+{
+  return interface->nr_ulsch_decoding_shutdown();
+}

openair1/PHY/INIT/nr_init.c

@@ -26,6 +26,7 @@
 #include "PHY/NR_REFSIG/nr_refsig.h"
 #include "PHY/INIT/nr_phy_init.h"
 #include "PHY/CODING/nrPolar_tools/nr_polar_pbch_defs.h"
+#include "PHY/CODING/nr_ulsch_decoding_interface.h"
 #include "PHY/NR_TRANSPORT/nr_transport_proto.h"
 #include "PHY/NR_TRANSPORT/nr_transport_common_proto.h"
 #include "PHY/NR_ESTIMATION/nr_ul_estimation.h"
@@ -101,6 +102,7 @@ void reset_active_stats(PHY_VARS_gNB *gNB, int frame)
 
 // A global var to reduce the changes size
 ldpc_interface_t ldpc_interface = {0}, ldpc_interface_offload = {0};
+nr_ulsch_decoding_interface_t nr_ulsch_decoding_interface = {0};
 
 int phy_init_nr_gNB(PHY_VARS_gNB *gNB)
 {
@@ -129,10 +131,14 @@ int phy_init_nr_gNB(PHY_VARS_gNB *gNB)
 
   nr_init_fde(); // Init array for frequency equalization of transform precoding of PUSCH
 
-  load_LDPClib(NULL, &ldpc_interface);
+  if (gNB->nr_ulsch_decoding_interface_flag){
+    load_nr_ulsch_decoding_interface(gNB->nr_ulsch_decoding_interface_version, &nr_ulsch_decoding_interface);
+  }else{
+    load_LDPClib(NULL, &ldpc_interface);
 
-  if (gNB->ldpc_offload_flag)
-    load_LDPClib("_t2", &ldpc_interface_offload);
+    if (gNB->ldpc_offload_flag)
+      load_LDPClib("_t2", &ldpc_interface_offload);
+  }
   gNB->max_nb_pdsch = MAX_MOBILES_PER_GNB;
   init_delay_table(fp->ofdm_symbol_size, MAX_DELAY_COMP, NR_MAX_OFDM_SYMBOL_SIZE, fp->delay_table);
 

openair1/PHY/defs_gNB.h

@@ -639,6 +639,10 @@ typedef struct PHY_VARS_gNB_s {
 
   int ldpc_offload_flag;
 
+  /// NR ULSCH decoding related
+  int nr_ulsch_decoding_interface_flag; // Flag enabling NR ULSCH decoding module
+  char nr_ulsch_decoding_interface_version[64];
+
   int max_ldpc_iterations;
   /// indicate the channel estimation technique in time domain
   int chest_time;

openair1/SCHED_NR/phy_procedures_nr_gNB.c

@@ -24,6 +24,7 @@
 #include "PHY/NR_TRANSPORT/nr_transport_proto.h"
 #include "PHY/NR_TRANSPORT/nr_dlsch.h"
 #include "PHY/NR_TRANSPORT/nr_ulsch.h"
+#include "PHY/CODING/nr_ulsch_decoding_interface.h"
 #include "PHY/NR_TRANSPORT/nr_dci.h"
 #include "PHY/NR_ESTIMATION/nr_ul_estimation.h"
 #include "nfapi/open-nFAPI/nfapi/public_inc/nfapi_interface.h"
@@ -355,6 +356,62 @@ static void nr_postDecode(PHY_VARS_gNB *gNB, notifiedFIFO_elt_t *req)
   }
 }
 
+static int nr_ulsch_procedures_slot(PHY_VARS_gNB *gNB, int frame_rx, int slot_rx)
+{
+  NR_DL_FRAME_PARMS *frame_parms = &gNB->frame_parms;
+  uint32_t *G = malloc(gNB->max_nb_pusch*sizeof(uint32_t));
+  for (int ULSCH_id = 0; ULSCH_id < gNB->max_nb_pusch; ULSCH_id++) {
+    nfapi_nr_pusch_pdu_t *pusch_pdu = &gNB->ulsch[ULSCH_id].harq_process->ulsch_pdu;
+
+    uint16_t nb_re_dmrs;
+    uint16_t start_symbol = pusch_pdu->start_symbol_index;
+    uint16_t number_symbols = pusch_pdu->nr_of_symbols;
+
+    uint8_t number_dmrs_symbols = 0;
+    for (int l = start_symbol; l < start_symbol + number_symbols; l++)
+      number_dmrs_symbols += ((pusch_pdu->ul_dmrs_symb_pos)>>l)&0x01;
+
+    if (pusch_pdu->dmrs_config_type==pusch_dmrs_type1)
+      nb_re_dmrs = 6*pusch_pdu->num_dmrs_cdm_grps_no_data;
+    else
+      nb_re_dmrs = 4*pusch_pdu->num_dmrs_cdm_grps_no_data;
+
+    G[ULSCH_id] = nr_get_G(pusch_pdu->rb_size,
+                          number_symbols,
+                          nb_re_dmrs,
+                          number_dmrs_symbols, // number of dmrs symbols irrespective of single or double symbol dmrs
+                          gNB->ulsch[ULSCH_id].unav_res,
+                          pusch_pdu->qam_mod_order,
+                          pusch_pdu->nrOfLayers);
+    AssertFatal(G[ULSCH_id]>0,"G is 0 : rb_size %u, number_symbols %d, nb_re_dmrs %d, number_dmrs_symbols %d, qam_mod_order %u, nrOfLayer %u\n",
+                pusch_pdu->rb_size,
+                number_symbols,
+                nb_re_dmrs,
+                number_dmrs_symbols, // number of dmrs symbols irrespective of single or double symbol dmrs
+                pusch_pdu->qam_mod_order,
+                pusch_pdu->nrOfLayers);
+    LOG_D(PHY,"rb_size %d, number_symbols %d, nb_re_dmrs %d, dmrs symbol positions %d, number_dmrs_symbols %d, qam_mod_order %d, nrOfLayer %d\n",
+          pusch_pdu->rb_size,
+          number_symbols,
+          nb_re_dmrs,
+          pusch_pdu->ul_dmrs_symb_pos,
+          number_dmrs_symbols, // number of dmrs symbols irrespective of single or double symbol dmrs
+          pusch_pdu->qam_mod_order,
+          pusch_pdu->nrOfLayers);
+  }
+  
+  //----------------------------------------------------------
+  //--------------------- ULSCH decoding ---------------------
+  //----------------------------------------------------------
+
+  start_meas(&gNB->ulsch_decoding_stats);
+  int nbDecode =
+      nr_ulsch_decoding_interface.nr_ulsch_decoding_decoder(gNB, frame_parms, frame_rx, slot_rx, G);
+
+  free(G);
+  return nbDecode;
+}
+
 static int nr_ulsch_procedures(PHY_VARS_gNB *gNB, int frame_rx, int slot_rx, int ULSCH_id, uint8_t harq_pid)
 {
   NR_DL_FRAME_PARMS *frame_parms = &gNB->frame_parms;
@@ -932,12 +989,28 @@ int phy_procedures_gNB_uespec_RX(PHY_VARS_gNB *gNB, int frame_rx, int slot_rx)
       VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_NR_RX_PUSCH, 0);
       // LOG_M("rxdataF_comp.m","rxF_comp",gNB->pusch_vars[0]->rxdataF_comp[0],6900,1,1);
       // LOG_M("rxdataF_ext.m","rxF_ext",gNB->pusch_vars[0]->rxdataF_ext[0],6900,1,1);
-      VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_NR_ULSCH_PROCEDURES_RX, 1);
-      int const tasks_added = nr_ulsch_procedures(gNB, frame_rx, slot_rx, ULSCH_id, ulsch->harq_pid);
-      if (tasks_added > 0)
-        totalDecode += tasks_added; 
+    }
+  }
+
+  if(gNB->nr_ulsch_decoding_interface_flag){
+    int const tasks_added = nr_ulsch_procedures_slot(gNB, frame_rx, slot_rx);
+    if (tasks_added > 0)
+      totalDecode += tasks_added; 
 
-      VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_NR_ULSCH_PROCEDURES_RX, 0);
+  }
+  else
+  {
+    for (int ULSCH_id = 0; ULSCH_id < gNB->max_nb_pusch; ULSCH_id++) {
+      NR_gNB_ULSCH_t *ulsch = &gNB->ulsch[ULSCH_id];
+  
+      if ((ulsch->active == true) && (ulsch->frame == frame_rx) && (ulsch->slot == slot_rx) && (ulsch->handled == 0)) {
+        VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_NR_ULSCH_PROCEDURES_RX, 1);
+        int const tasks_added = nr_ulsch_procedures(gNB, frame_rx, slot_rx, ULSCH_id, ulsch->harq_pid);
+        if (tasks_added > 0)
+          totalDecode += tasks_added; 
+
+        VCD_SIGNAL_DUMPER_DUMP_FUNCTION_BY_NAME(VCD_SIGNAL_DUMPER_FUNCTIONS_NR_ULSCH_PROCEDURES_RX, 0);
+      }
     }
   }
     while (totalDecode > 0) {

openair1/SIMULATION/NR_PHY/ulsim.c

@@ -187,6 +187,8 @@ int main(int argc, char *argv[])
   double effTP;
   float eff_tp_check = 100;
   int ldpc_offload_flag = 0;
+  int nr_ulsch_decoding_interface_flag = 0;
+  char nr_ulsch_decoding_interface_version[64] = "_demo";
   uint8_t max_rounds = 4;
   int chest_type[2] = {0};
   int enable_ptrs = 0;
@@ -223,7 +225,7 @@ int main(int argc, char *argv[])
   /* initialize the sin-cos table */
   InitSinLUT();
 
-  while ((c = getopt(argc, argv, "a:b:c:d:ef:g:h:i:k:m:n:op:q:r:s:t:u:v:w:y:z:C:F:G:H:I:M:N:PR:S:T:U:L:ZW:E:X:")) != -1) {
+  while ((c = getopt(argc, argv, "a:b:c:d:ef:g:h:i:j:k:m:n:op:q:r:s:t:u:v:w:y:z:C:F:G:H:I:M:N:PR:S:T:U:L:ZW:E:X:")) != -1) {
     printf("handling optarg %c\n",c);
     switch (c) {
 
@@ -312,6 +314,10 @@ int main(int argc, char *argv[])
         i+=2;
       } while (optarg[i-1] == ',');
       break;
+
+    case 'j':
+      nr_ulsch_decoding_interface_flag = 1;
+      strncpy(nr_ulsch_decoding_interface_version,optarg,63);
 	
     case 'k':
       printf("Setting threequarter_fs_flag\n");
@@ -631,6 +637,8 @@ int main(int argc, char *argv[])
 
 //  nr_phy_config_request_sim(gNB,N_RB_DL,N_RB_DL,mu,0,0x01);
   gNB->ldpc_offload_flag = ldpc_offload_flag;
+  gNB->nr_ulsch_decoding_interface_flag = nr_ulsch_decoding_interface_flag;
+  strncpy(gNB->nr_ulsch_decoding_interface_version,nr_ulsch_decoding_interface_version,64);
   gNB->chest_freq = chest_type[0];
   gNB->chest_time = chest_type[1];