fix phy simulators build Pb: move snr_dB global to simulation code, add a...

fix phy simulators build Pb: move snr_dB global to simulation code, add a channel mode section in configuration for snr_dB ,add a parameter flag in the config module to allow omitting prefix when modifying a parameter (for compatibility of -s option)

cmake_targets/CMakeLists.txt

@@ -1833,7 +1833,7 @@ ${OPENAIR1_DIR}/SIMULATION/TOOLS/channel_sim.c
 ${OPENAIR1_DIR}/SIMULATION/RF/rf.c
 ${OPENAIR1_DIR}/SIMULATION/RF/dac.c
 ${OPENAIR1_DIR}/SIMULATION/RF/adc.c
-${OPENAIR_DIR}/targets/ARCH/rfsimulator/channelmod.c
+${OPENAIR_DIR}/targets/ARCH/rfsimulator/apply_channelmod.c
 #${OPENAIR1_DIR}/SIMULATION/ETH_TRANSPORT/netlink_init.c
 )
 

common/config/DOC/config/devusage/api.md

+## config module management
+
 ```c
 configmodule_interface_t *load_configmodule(int argc, char **argv, uint32_t initflags)
 ```
@@ -14,23 +16,17 @@ void End_configmodule(void)
 * Free memory which has been allocated by the configuration module since its initialization.
 * Possibly calls the `config_<config source>_end` function
 
+## Retrieving parameter's values
+
 ```c
 int config_get(paramdef_t *params,int numparams, char *prefix)
 ```
 * Reads as many parameters as described in params, they must all be in the same configuration file section
 * Calls the `config_<config source>_get` function
 * Calls the `config_process_cmdline` function
-* `params` points to an array of `paramdef_t` structures which describes the parameters to be read, possibly including a pointer to a checking function. The following bits can possibly be set in the `paramflags` mask before calling
- - `PARAMFLAG_MANDATORY`: -1 is returned if the parameter is not explicitly defined in the config source.
- - `PARAMFLAG_DISABLECMDLINE`: parameter cannot be modified via the command line
- - `PARAMFLAG_DONOTREAD`: ignore the parameter, can be used at run-time, to alter a pre-defined `paramdef_t` array which is used in several `config_get` or/and `config_getlist` calls.
- - `PARAMFLAG_NOFREE`: do not free the memory possibly allocated by the config module to store the value of the parameter. Default behavior is for the config module to free the memory it has allocated when the `config_end` function is called.
- - `PARAMFLAG_BOOL`: Only relevant for integer types. tell the config module that when processing the command line, the corresponding option can be specified without any arggument and that in this case it must set the value to 1.
-
-* `params` is also used as an output parameter, `< XXX >ptr >` field  is used by the config module to store the value it has read. The following bits can possibly be set in the `paramflags` mask after the call:
-  - `PARAMFLAG_MALLOCINCONFIG`: memory has been allocated for the ` < XXX >ptr > ` field
-  - `PARAMFLAG_PARAMSET`: parameter has been found in the config source, it is not set to default value.
-  - `PARAMFLAG_PARAMSET`: parameter has been set to its default value
+* `params` points to an array of `paramdef_t` structures which describes the parameters to be read, possibly including a pointer to a checking function.The `paramflags` bit mask can be used to modify how a specific parameter is processed and the same mask is also used by the configuration module to return information about how the parameter has been processed. Bits definitions are described in the [`paramdef_t` structure description](./struct.md)
+
+
 * `numparams` is the number of entries in the params array
 * `prefix` is a character string to be appended to the parameters name, it defines the parameters position in the configuration file hierarchy (the section name in libconfig terminology).
 * The returned value is the number of parameters which have been assigned a value or -1 if a severe error occured
@@ -44,6 +40,9 @@ int config_libconfig_getlist(paramlist_def_t *ParamList, paramdef_t *params, int
 * `ParamList`  points to a structure, where `paramarray` field points to an array of `paramdef_t` structure, allocated by the function. It is used to return the values of the parameters.
 * The returned value is the number of occurrences in the list or -1 in case of severe error
 
+## utility functions and macros
+
+The configuration module also defines APIs to access the  `paramdef_t` and `configmodule_interface_t` fields. They are listed in the configuration module [include file `common/config/config_userapi.h`](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_userapi.h)
 
 [Configuration module developer main page](../../config/devusage.md)
 [Configuration module home](../../config.md)

common/config/DOC/config/devusage/struct.md

@@ -5,6 +5,7 @@ It is defined in include file [ common/config/config_paramdesc.h ](https://gitla
 |:-----------|:------------------------------------------------------------------|----:|
 | `optname`    | parameter name, as used when looking for it in the config source, 63 bytes max (64 with trailing \0) | I |
 | `helstr`     | pointer to a C string printed when using --help on the command line | I |
+| `paramflags` | bit mask, used to modify how the parameter is processed, or to return to the API caller how the parameter has been set, see list in the next table | IO |
 | `strptr` `strlistptr` `u8ptr` `i8ptr` `u16ptr` `i16ptr` `uptr` `iptr` `u64ptr` `i64ptr` `dblptr` `voidptr` | a pointer to a variable where the parameter value(s) will be returned. This field is an anonymous union, the supported pointer types have been built to avoid type mismatch warnings at compile time. | O |
 | `defstrval` `defstrlistval` `defuintval` `defintval` `defint64val` `defintarrayval` `defdblval` | this field is an anonymous union, it can be used to define the default value for the parameter. It is ignored if `PARAMFLAG_MANDATORY` is set in the `paramflags` field.| I |
 | `type` | Supported parameter types are defined as integer macros. Supported simple types are `TYPE_STRING`, parameter value is returned in `strptr` field,  `TYPE_INT8` `TYPE_UINT8` `TYPE_INT16` `TYPE_UINT16` `TYPE_INT32` `TYPE_UINT32` `TYPE_INT64` `TYPE_UINT64`, parameter value is returned in the corresponding uXptr or iXptr, `TYPE_MASK`, value is returned in `u32ptr`, `TYPE_DOUBLE` value is returned in `dblptr`, `TYPE_IPV4ADDR` value is returned in binary, network bytes order in `u32ptr` field. `TYPE_STRINGLIST`, `TYPE_INTARRAY` and `TYPE_UINTARRAY` are multiple values types. Multiple values are returned in respectively, `strlistptr`, `iptr` and `uptr` fields which then point to arrays. The  `numelt` field gives the number of item in the array. | I |
@@ -12,6 +13,22 @@ It is defined in include file [ common/config/config_paramdesc.h ](https://gitla
 | `chkPptr` | possible pointer to the structure containing the info used to check parameter values | I |
 | `processedvalue` | When `chkPptr` is not `ǸULL`, is used to return a value, computed from the original parameter, as read from the configuration source. | O |
 
+## `paramflags` bits definition
+
+
+| C macro bit definition               | usage                                                                                                                | I/O |
+|:-------------------------------------|:---------------------------------------------------------------------------------------------------------------------|----:|
+| `PARAMFLAG_MANDATORY`                | parameter is mandatory, comfiguration module will stop the process if it is not specified. Default value is ignored  | I |
+| `PARAMFLAG_DISABLECMDLINE`           | parameter cannot be specified on the command line                                                                    | I |
+| `PARAMFLAG_DONOTREAD`                | ignore the parameter, usefull when a parameter group is used in different context                                    | I |
+| `PARAMFLAG_NOFREE`                   | The end_configmodule API won't free the memory which has been possibly allocated to store the value of the parameter.| I |
+| `PARAMFLAG_BOOL`                     | Parameter is a boolean, it can be specified without a value to set it to true                                        | I |
+| `PARAMFLAG_CMDLINE_NOPREFIXENABLED`  | parameter can be specified without the prefix on the command line. Must be used with care, carefuly checking unicity, especially for short parameter names | I |
+| `PARAMFLAG_MALLOCINCONFIG`           | Memory for the parameter value has been allocated by the configuration module                                         |O |       
+| `PARAMFLAG_PARAMSET`                 | Parameter value has been explicitely set, as the parameter was specified either on the command line or the config source | O |
+| `PARAMFLAG_PARAMSETDEF`              | Parameter value has been set to it's default                                                                          | O |            
+
+
 # `paramlist_def_t`structure
 It is defined in include file [ common/config/config_paramdesc.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h#L160).
 It is used as an argument to `config_getlist` calls, to get values of multiple occurrences of group of parameters.

common/config/config_cmdline.c

@@ -167,8 +167,8 @@ int config_check_unknown_cmdlineopt(char *prefix) {
   char testprefix[CONFIG_MAXOPTLENGTH];
   int finalcheck = 0;
   memset(testprefix,0,sizeof(testprefix));
-
   memset(testprefix,0,sizeof(testprefix));
+
   if (prefix != NULL) {
     if (strcmp(prefix,CONFIG_CHECKALLSECTIONS) == 0)
       finalcheck = 1;
@@ -253,7 +253,9 @@ int config_process_cmdline(paramdef_t *cfgoptions,int numoptions, char *prefix)
         }
 
         if ( ((strlen(oneargv) == 2) && (strcmp(oneargv + 1,cfgpath) == 0))  || /* short option, one "-" */
-             ((strlen(oneargv) > 2) && (strcmp(oneargv + 2,cfgpath ) == 0 )) ) {
+             ((strlen(oneargv) > 2) && (strcmp(oneargv + 2,cfgpath ) == 0 )) || /* long option beginning with "--" */
+             ((strlen(oneargv) == 2) && (strcmp(oneargv + 1,cfgoptions[n].optname) == 0) && (cfgoptions[n].paramflags & PARAMFLAG_CMDLINE_NOPREFIXENABLED )) ||
+             ((strlen(oneargv) > 2) && (strcmp(oneargv + 2,cfgpath ) == 0 ) && (cfgoptions[n].paramflags & PARAMFLAG_CMDLINE_NOPREFIXENABLED )) ) {
           char *valptr=NULL;
           int ret;
           config_get_if()->argv_info[i] |= CONFIG_CMDLINEOPT_PROCESSED;

common/config/config_paramdesc.h

@@ -48,7 +48,7 @@
 #define PARAMFLAG_DONOTREAD               (1 << 2)         // parameter must be ignored in get function
 #define PARAMFLAG_NOFREE                  (1 << 3)         // don't free parameter in end function
 #define PARAMFLAG_BOOL                    (1 << 4)         // integer param can be 0 or 1
-
+#define PARAMFLAG_CMDLINE_NOPREFIXENABLED (1 << 5)         // on the command line, allow a parameter to be specified without the prefix
 
 /*   Flags used by config modules to return info to calling modules and/or to  for internal usage*/
 #define PARAMFLAG_MALLOCINCONFIG          (1 << 15)        // parameter allocated in config module

openair1/SIMULATION/TOOLS/random_channel.c

@@ -30,9 +30,9 @@
 #include "sim.h"
 #include "scm_corrmat.h"
 #include "common/utils/LOG/log.h"
-#include "common/utils/load_module_shlib.h"
+#include "common/config/config_userapi.h"
 #include "common/utils/telnetsrv/telnetsrv.h"
-
+#include "common/utils/load_module_shlib.h"
 
 
 //#define DEBUG_CH
@@ -54,6 +54,9 @@ static telnetshell_vardef_t channelmod_vardef[] = {
   {"",0,NULL}
 };
 
+static double snr_dB=25;
+static double sinr_dB=0;
+
 void fill_channel_desc(channel_desc_t *chan_desc,
                        uint8_t nb_tx,
                        uint8_t nb_rx,
@@ -1497,18 +1500,31 @@ static int channelmod_show_cmd(char *buff, int debug, telnet_printfunc_t prnt) {
   return 0;
 }
 
-int init_channelmod(char *modelname) {
+int modelid_fromname(char *modelname) {
   int modelid=map_str_to_int(channelmod_names,modelname);
   AssertFatal(modelid>0,
               "random_channel.c: Error channel model %s unknown\n",modelname);
-  /* look for telnet server, if it is loaded, add the coding commands to it */
+  return modelid;
+}
+
+double channelmod_get_snr_dB(void) {
+  return snr_dB;
+}
+
+double channelmod_get_sinr_dB(void) {
+  return sinr_dB;
+}
+
+void init_channelmod(void) {
+  paramdef_t channelmod_params[] = CHANNELMOD_PARAMS_DESC;
+  int ret = config_get( channelmod_params,sizeof(channelmod_params)/sizeof(paramdef_t),CHANNELMOD_SECTION);
+  AssertFatal(ret >= 0, "configuration couldn't be performed");
+  /* look for telnet server, if it is loaded, add the channel modeling commands to it */
   add_telnetcmd_func_t addcmd = (add_telnetcmd_func_t)get_shlibmodule_fptr("telnetsrv", TELNET_ADDCMD_FNAME);
 
   if (addcmd != NULL) {
     addcmd("channelmod",channelmod_vardef,channelmod_cmdarray);
   }
-
-  return modelid;
 }
 
 #ifdef RANDOM_CHANNEL_MAIN

openair1/SIMULATION/TOOLS/sim.h

@@ -211,6 +211,13 @@ typedef enum {
   {"EPA_high",EPA_high},\
   {NULL, -1}
 
+#define CONFIG_HLP_SNR           "Set average SNR in dB (for --siml1 option)\n"
+#define CHANNELMOD_SECTION "channelmod"
+#define CHANNELMOD_PARAMS_DESC {  \
+    {"s" ,CONFIG_HLP_SNR, PARAMFLAG_CMDLINE_NOPREFIXENABLED ,               dblptr:&snr_dB,                       defdblval:25,         TYPE_DOUBLE,      0},\
+    {"sinr_dB" ,NULL,     0                                 ,               dblptr:&sinr_dB,                       defdblval:0,         TYPE_DOUBLE,      0},\
+  }
+
 #include "platform_constants.h"
 
 typedef struct {
@@ -432,7 +439,11 @@ void rxAddInput( struct complex16 *input_sig, struct complex16 *after_channel_si
                  uint64_t TS,
                  uint32_t CirSize
                );
-int init_channelmod(char *channelname) ;
+
+int modelid_fromname(char *modelname);
+double channelmod_get_snr_dB(void);
+double channelmod_get_sinr_dB(void);
+void init_channelmod(void) ;
 
 double N_RB2sampling_rate(uint16_t N_RB);
 double N_RB2channel_bandwidth(uint16_t N_RB);

targets/ARCH/rfsimulator/channelmod.c → targets/ARCH/rfsimulator/apply_channelmod.c

@@ -52,7 +52,7 @@ void rxAddInput( struct complex16 *input_sig, struct complex16 *after_channel_si
   // Fixme: how to convert a noise in Watt into a 12 bits value out of the RF ADC ?
   // the parameter "-s" is declared as SNR, but the input power is not well defined
   // −132.24 dBm is a LTE subcarrier noise, that was used in origin code (15KHz BW thermal noise)
-  const double rxGain= 132.24 - snr_dB;
+  const double rxGain= 132.24 - channelmod_get_snr_dB();
   // sqrt(4*noise_figure_watt) is the thermal noise factor (volts)
   // fixme: the last constant is pure trial results to make decent noise
   const double noise_per_sample = sqrt(4*noise_figure_watt) * pow(10,rxGain/20) *10;

targets/ARCH/rfsimulator/simulator.c

@@ -42,7 +42,7 @@
 
 // Fixme: datamodel, external variables in .h files, ...
 #include <common/ran_context.h>
-extern double snr_dB;
+
 extern RAN_CONTEXT_t RC;
 //
 
@@ -91,7 +91,7 @@ typedef struct {
   int tx_num_channels;
   double sample_rate;
   double tx_bw;
-  bool   enable_channelmod;
+  int channelmod;
 } rfsimulator_state_t;
 
 
@@ -112,7 +112,7 @@ void allocCirBuf(rfsimulator_state_t *bridge, int sock) {
   ev.data.fd = sock;
   AssertFatal(epoll_ctl(bridge->epollfd, EPOLL_CTL_ADD,  sock, &ev) != -1, "");
 
-  if ( bridge->enable_channelmod==true) {
+  if ( bridge->channelmod > 0) {
     // create channel simulation model for this mode reception
     // snr_dB is pure global, coming from configuration paramter "-s"
     // Fixme: referenceSignalPower should come from the right place
@@ -126,7 +126,7 @@ void allocCirBuf(rfsimulator_state_t *bridge, int sock) {
     // Legacy changes directlty the variable channel_model->path_loss_dB place to place
     // while calling new_channel_desc_scm() with path losses = 0
     ptr->channel_model=new_channel_desc_scm(bridge->tx_num_channels,bridge->rx_num_channels,
-                                            AWGN,
+                                            bridge->channelmod,
                                             bridge->sample_rate,
                                             bridge->tx_bw,
                                             0.0, // forgetting_factor
@@ -239,8 +239,8 @@ void rfsimulator_readconfig(rfsimulator_state_t *rfsimulator) {
 
       break;
     } else if (strcmp(rfsimu_params[p].strlistptr[i],"chanmod") == 0) {
-      init_channelmod(modelname);
-      rfsimulator->enable_channelmod=true;
+      init_channelmod();
+      rfsimulator->channelmod=modelid_fromname(modelname);
     } else {
       fprintf(stderr,"Unknown rfsimulator option: %s\n",rfsimu_params[p].strlistptr[i]);
       exit(-1);

targets/RT/USER/lte-softmodem-common.c

@@ -38,7 +38,7 @@
 static softmodem_params_t softmodem_params;
 char *parallel_config=NULL;
 char *worker_config=NULL;
-double snr_dB=25;
+
 
 uint64_t get_softmodem_optmask(void) {
   return softmodem_params.optmask;

targets/RT/USER/lte-softmodem.h

@@ -78,7 +78,6 @@
 #define CONFIG_HLP_MSLOTS        "Skip the missed slots/subframes \n"
 #define CONFIG_HLP_ULMCS         "Set the maximum uplink MCS\n"
 #define CONFIG_HLP_TDD           "Set hardware to TDD mode (default: FDD). Used only with -U (otherwise set in config file).\n"
-#define CONFIG_HLP_SNR           "Set average SNR in dB (for --siml1 option)\n"
 #define CONFIG_HLP_UE            "Set the lte softmodem as a UE\n"
 #define CONFIG_HLP_TQFS          "Apply three-quarter of sampling frequency, 23.04 Msps to reduce the data rate on USB/PCIe transfers (only valid for 20 MHz)\n"
 #define CONFIG_HLP_TPORT         "tracer port\n"
@@ -200,7 +199,6 @@
     {"d" ,                      CONFIG_HLP_SOFTS,       PARAMFLAG_BOOL,         uptr:(uint32_t *)&do_forms,         defintval:0,                    TYPE_INT8,      0},                     \
     {"q" ,                      CONFIG_HLP_STMON,       PARAMFLAG_BOOL,         iptr:&opp_enabled,                  defintval:0,                    TYPE_INT,       0},                     \
     {"S" ,                      CONFIG_HLP_MSLOTS,      PARAMFLAG_BOOL,         u8ptr:&exit_missed_slots,           defintval:1,                    TYPE_UINT8,     0},                     \
-    {"s" ,                         CONFIG_HLP_SNR,         0,               dblptr:&snr_dB,                       defdblval:25,         TYPE_DOUBLE,      0},   \
     {"numerology" ,             CONFIG_HLP_NUMEROLOGY,  PARAMFLAG_BOOL,         iptr:&NUMEROLOGY,                   defintval:0,                    TYPE_INT,       0},                     \
     {"parallel-config",         CONFIG_HLP_PARALLEL_CMD,0,                      strptr:(char **)&parallel_config,   defstrval:NULL,                 TYPE_STRING,    0},                     \
     {"worker-config",           CONFIG_HLP_WORKER_CMD,  0,                      strptr:(char **)&worker_config,     defstrval:NULL,                 TYPE_STRING,    0},                     \
@@ -264,9 +262,9 @@ typedef struct {
   int            numerology;
   unsigned int   start_msc;
   uint32_t       clock_source;
-  uint32_t       timing_source; 
+  uint32_t       timing_source;
   int            hw_timing_advance;
-  uint32_t       send_dmrs_sync; 
+  uint32_t       send_dmrs_sync;
 } softmodem_params_t;
 
 #define IS_SOFTMODEM_NOS1            ( get_softmodem_optmask() & SOFTMODEM_NOS1_BIT)
@@ -285,8 +283,6 @@ uint64_t get_pdcp_optmask(void);
 extern pthread_cond_t sync_cond;
 extern pthread_mutex_t sync_mutex;
 extern int sync_var;
-extern double snr_dB;
-
 
 extern uint32_t          downlink_frequency[MAX_NUM_CCs][4];
 extern int32_t           uplink_frequency_offset[MAX_NUM_CCs][4];
@@ -311,7 +307,7 @@ extern void stop_eNB(int);
 extern void kill_eNB_proc(int inst);
 
 // In lte-ru.c
-extern void init_RU(char*,clock_source_t clock_source,clock_source_t time_source,int send_dmrssync);
+extern void init_RU(char *,clock_source_t clock_source,clock_source_t time_source,int send_dmrssync);
 extern void stop_ru(RU_t *ru);
 extern void init_ru_vnf(void);
 extern void init_RU_proc(RU_t *ru);
@@ -337,7 +333,7 @@ extern void kill_td_thread(PHY_VARS_eNB *);
 extern void kill_te_thread(PHY_VARS_eNB *);
 
 extern void RCConfig_sim(void);
-extern void init_ocm(double,double);
+extern void init_ocm(void);
 extern void init_ue_devices(PHY_VARS_UE *);
 
 PHY_VARS_UE *init_ue_vars(LTE_DL_FRAME_PARMS *frame_parms,

targets/RT/USER/lte-uesoftmodem.c

@@ -811,7 +811,7 @@ int main( int argc, char **argv ) {
   //p_exmimo_config->framing.tdd_config = TXRXSWITCH_TESTRX;
 
   if (IS_SOFTMODEM_SIML1 )  {
-    init_ocm(snr_dB,0);
+    init_ocm();
     PHY_vars_UE_g[0][0]->no_timing_correction = 1;
   }
 

targets/RT/USER/rfsim.h

@@ -27,7 +27,7 @@
 #include "PHY/defs_UE.h"
 #include "PHY/defs_eNB.h"
 
-void init_ocm(double snr_dB,double sinr_dB);
+void init_ocm(void);
 
 void update_ocm(double snr_dB,double sinr_dB);
 
@@ -37,4 +37,4 @@ void update_ocm(double snr_dB,double sinr_dB);
 
 void init_channel_vars(void);
 
-#endif 
+#endif