YAML as a drop-in replacement for libconfig

This commit introduces a substitute module library for setting up softmodems using YAML instead of libconfig.
The softmodems should work the same with both types of files. Extra care was put to make sure the behavior
of both modules is the same.

Example yaml config files were added for the UE and gNB

ci-scripts/conf_files/nrue.uicc.yaml

+uicc0:
+  imsi: 208990100001100
+  key: fec86ba6eb707ed08905757b1bb44b8f
+  opc: C42449363BBAD02B66D16BC975D77CC1
+  dnn: oai
+  nssai_sst: 1
+
+#/* configuration for channel modelisation */
+#/* To be included in main config file when */
+#/* channel modelisation is used (rfsimulator with chanmod options enabled) */
+channelmod:
+  max_chan: 10;
+  modellist: modellist_rfsimu_1
+  modellist_rfsimu_1:
+    - model_name: rfsimu_channel_enB0
+      type: AWGN
+      ploss_dB: 20
+      noise_power_dB: -4
+      forgetfact: 0
+      offset: 0
+      ds_tdl: 0
+    - model_name: rfsimu_channel_ue0
+      type: AWGN
+      ploss_dB: 20
+      nose_power_dB: -2
+      forgetfact: 0
+      offset: 0
+      ds_tdl: 0

cmake_targets/tools/build_helper

@@ -589,8 +589,9 @@ check_install_oai_software() {
 	libtool  \
 	patch \
 	openssl \
-        zlib1g-dev \
-        xxd
+	zlib1g-dev \
+	xxd \
+	libyaml-cpp-dev
 
   elif [[ "$OS_BASEDISTRO" == "fedora" ]]; then
     if [[ "$OS_DISTRO" == "rhel" ]] || [[ "$OS_DISTRO" == "centos" ]] || [[ "$OS_DISTRO" == "rocky" ]]; then
@@ -625,7 +626,8 @@ check_install_oai_software() {
       blas \
       blas-devel \
       vim-common \
-      zlib-devel
+      zlib-devel \
+      yaml-cpp-devel
   fi
 
     install_asn1c_from_source $1

common/CMakeLists.txt

 add_subdirectory(utils)
+add_subdirectory(config/yaml)
 
 configure_file(oai_version.h.in oai_version.h @ONLY)

common/config/config_load_configmodule.c

@@ -293,8 +293,12 @@ configmodule_interface_t *load_configmodule(int argc,
   } else if ( i == 1 ) {
     /* -O argument doesn't contain ":" separator, assume -O <conf file> option, default cfgmode to libconfig
        with one parameter, the path to the configuration file cfgmode must not be NULL */
-    modeparams=cfgmode;
-    cfgmode=strdup(CONFIG_LIBCONFIGFILE);
+    modeparams = cfgmode;
+    if (strstr(modeparams, ".yaml") != NULL || strstr(modeparams, ".yml") != NULL) {
+      cfgmode = strdup("yaml");
+    } else {
+      cfgmode = strdup(CONFIG_LIBCONFIGFILE);
+    }
   }
   static configmodule_interface_t *cfgptr;
   if (cfgptr)

common/config/yaml/CMakeLists.txt

+find_package(yaml-cpp REQUIRED)
+
+# include(FetchContent)
+
+# FetchContent_Declare(
+#   yaml-cpp
+#   GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git
+#   GIT_TAG 0.8.0
+# )
+# FetchContent_GetProperties(yaml-cpp)
+
+# if(NOT yaml-cpp_POPULATED)
+#   message(STATUS "Fetching yaml-cpp...")
+#   FetchContent_Populate(yaml-cpp)
+#   add_subdirectory(${yaml-cpp_SOURCE_DIR} ${yaml-cpp_BINARY_DIR})
+# endif()
+
+add_library(params_yaml_static config_yaml.cpp)
+target_link_libraries(params_yaml_static PUBLIC UTIL yaml-cpp)
+if (ENABLE_TESTS)
+  add_subdirectory(tests)
+endif()
+
+add_library(params_yaml MODULE config_yaml.cpp)
+target_link_libraries(params_yaml PUBLIC UTIL yaml-cpp)
+set_target_properties(params_yaml PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})

common/config/yaml/tests/CMakeLists.txt

+add_executable(test_yaml_config test_yaml_config.cpp)
+target_link_libraries(test_yaml_config PRIVATE params_yaml_static GTest::gtest)
+add_dependencies(tests test_yaml_config)
+add_test(NAME test_yaml_config
+  COMMAND ./test_yaml_config)
+configure_file(test1.yaml test1.yaml COPYONLY)
+configure_file(test_recursion.yaml test_recursion.yaml COPYONLY)
+configure_file(test_list.yaml test_list.yaml COPYONLY)
+configure_file(test_string.yaml test_string.yaml COPYONLY)
+configure_file(test_list_of_mappings.yml test_list_of_mappings.yml COPYONLY)
+configure_file(test_int_array.yaml test_int_array.yaml COPYONLY)

common/config/yaml/tests/test1.yaml

+test:
+  value1: 1
+  value2: 2
+  value3: 3

common/config/yaml/tests/test_int_array.yaml

+test:
+  array: [1, 2, 3, 4]
+  array2:
+    - 1
+    - 2
+    - 3

common/config/yaml/tests/test_list.yaml

+test:
+  -
+    value1: 1
+    value2: 2
+    value3: 3
+  -
+    value1: 4
+    value2: 5
+    value3: 6
+  -
+    value1: 7
+    value2: 8
+    value3: 9

common/config/yaml/tests/test_list_of_mappings.yml

+test:
+  list:
+    - value1: 1
+      value2: 3
+      list:
+        - value1
+        - value2
+        - value3
+    - value: 2
+      value2: 6
+      list:
+        - value4
+        - value5
+        - value6

common/config/yaml/tests/test_recursion.yaml

+test:
+  test1:
+    test2:
+      test3:
+        test4:
+          value1: 1
+          value2: 2
+          value3: 3

common/config/yaml/tests/test_string.yaml

+test:
+  stringvalue: testvalue
+  stringlist:
+    - testvalue1
+    - testvalue2
+    - testvalue3

targets/PROJECTS/GENERIC-NR-5GC/CONF/gnb.sa.band78.fr1.106PRB.usrpb210.yaml

+Active_gNBs:
+  - gNB-OAI
+Asn1_verbosity: none
+gNBs:
+    # Identification parameters:
+  - gNB_ID: 0xe00
+    gNB_name: gNB-OAI
+    # Tracking area code, 0x0000 and 0xfffe are reserved values
+    tracking_area_code: 1
+    plmn_list:
+      -
+        mcc: 001
+        mnc: 01
+        mnc_length: 2
+        snssaiList:
+          -
+            sst: 1
+    nr_cellid: 12345678
+    # Physical parameters:
+    do_CSIRS: 1
+    do_SRS: 1
+    servingCellConfigCommon:
+        #spCellConfigCommon
+      - physCellId: 0
+        #  downlinkConfigCommon
+        #frequencyInfoDL
+        # this is 3600 MHz + 43 PRBs@30kHz SCS (same as initial BWP)
+        absoluteFrequencySSB: 641280
+        dl_frequencyBand: 78
+        # this is 3600 MHz
+        dl_absoluteFrequencyPointA: 640008
+        #scs-SpecificCarrierList
+        dl_offstToCarrier: 0
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        dl_subcarrierSpacing: 1
+        dl_carrierBandwidth: 106
+        #initialDownlinkBWP
+        #genericParameters
+        # this is RBstart=27,L=48 (275*(L-1))+RBstart
+        initialDLBWPlocationAndBandwidth: 28875 # 6366 12925 12956 28875 12952
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        initialDLBWPsubcarrierSpacing: 1
+        #pdcch-ConfigCommon
+        initialDLBWPcontrolResourceSetZero: 12
+        initialDLBWPsearchSpaceZero: 0
+        #uplinkConfigCommon
+        #frequencyInfoUL
+        ul_frequencyBand: 78
+        #scs-SpecificCarrierList
+        ul_offstToCarrier: 0
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        ul_subcarrierSpacing: 1
+        ul_carrierBandwidth: 106
+        pMax: 20
+        #initialUplinkBWP
+        #genericParameters
+        initialULBWPlocationAndBandwidth: 28875
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        initialULBWPsubcarrierSpacing: 1
+        #rach-ConfigCommon
+        #rach-ConfigGeneric
+        prach_ConfigurationIndex: 98
+        #prach_msg1_FDM
+        #0 = one, 1=two, 2=four, 3=eight
+        prach_msg1_FDM: 0
+        prach_msg1_FrequencyStart: 0
+        zeroCorrelationZoneConfig: 13
+        preambleReceivedTargetPower: -96
+        #preamblTransMax (0...10) = (3,4,5,6,7,8,10,20,50,100,200)
+        preambleTransMax: 6
+        #powerRampingStep
+        # 0=dB0,1=dB2,2=dB4,3=dB6
+        powerRampingStep: 1
+        #ra_ReponseWindow
+        #1,2,4,8,10,20,40,80
+        ra_ResponseWindow: 4
+        #ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR
+        #1=oneeighth,2=onefourth,3=half,4=one,5=two,6=four,7=eight,8=sixteen
+        ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR: 4
+        #oneHalf (0..15) 4,8,12,16,...60,64
+        ssb_perRACH_OccasionAndCB_PreamblesPerSSB: 14
+        #ra_ContentionResolutionTimer
+        #(0..7) 8,16,24,32,40,48,56,64
+        ra_ContentionResolutionTimer: 7
+        rsrp_ThresholdSSB: 19
+        #prach-RootSequenceIndex_PR
+        #1 = 839, 2 = 139
+        prach_RootSequenceIndex_PR: 2
+        prach_RootSequenceIndex: 1
+        # SCS for msg1, can only be 15 for 30 kHz < 6 GHz, takes precendence over the one derived from prach-ConfigIndex
+        msg1_SubcarrierSpacing: 1
+        # restrictedSetConfig
+        # 0=unrestricted, 1=restricted type A, 2=restricted type B
+        restrictedSetConfig: 0
+        msg3_DeltaPreamble: 1
+        p0_NominalWithGrant: -90
+        # pucch-ConfigCommon setup :
+        # pucchGroupHopping
+        # 0 = neither, 1= group hopping, 2=sequence hopping
+        pucchGroupHopping: 0
+        hoppingId: 40
+        p0_nominal: -90
+        # ssb_PositionsInBurs_BitmapPR
+        # 1=short, 2=medium, 3=long
+        ssb_PositionsInBurst_PR: 2
+        ssb_PositionsInBurst_Bitmap: 1
+
+        # ssb_periodicityServingCell
+        # 0 = ms5, 1=ms10, 2=ms20, 3=ms40, 4=ms80, 5=ms160, 6=spare2, 7=spare1
+        ssb_periodicityServingCell: 2
+
+        # dmrs_TypeA_position
+        # 0 = pos2, 1 = pos3
+        dmrs_TypeA_Position: 0
+
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        subcarrierSpacing: 1
+
+
+        #tdd-UL-DL-ConfigurationCommon
+        # subcarrierSpacing
+        # 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        referenceSubcarrierSpacing: 1
+        # pattern1
+        # dl_UL_TransmissionPeriodicity
+        # 0=ms0p5, 1=ms0p625, 2=ms1, 3=ms1p25, 4=ms2, 5=ms2p5, 6=ms5, 7=ms10
+        dl_UL_TransmissionPeriodicity: 6
+        nrofDownlinkSlots: 7
+        nrofDownlinkSymbols: 6
+        nrofUplinkSlots: 2
+        nrofUplinkSymbols: 4
+
+        ssPBCH_BlockPower: -25
+    SCTP:
+      SCTP_INSTREAMS: 2
+      SCTP_OUTSTREAMS: 2
+
+
+    # AMF parameters:
+    amf_ip_address:
+      ipv4: 192.168.70.132
+
+
+    NETWORK_INTERFACES:
+      GNB_IPV4_ADDRESS_FOR_NG_AMF: 192.168.70.129
+      GNB_IPV4_ADDRESS_FOR_NGU: 192.168.70.129
+      GNB_PORT_FOR_S1U: 2152 # Spec 2152
+
+MACRLCs:
+  -
+    num_cc: 1
+    tr_s_preference: local_L1
+    tr_n_preference: local_RRC
+    pusch_TargetSNRx10: 150
+    pucch_TargetSNRx10: 200
+
+L1s:
+  -
+    num_cc: 1
+    tr_n_preference: local_mac
+    prach_dtx_threshold: 120
+    pucch0_dtx_threshold: 100
+    ofdm_offset_divisor: 8 #set this to UINT_MAX for offset 0
+
+RUs:
+  -
+    local_rf: yes
+    nb_tx: 1
+    nb_rx: 1
+    att_tx: 12
+    att_rx: 12
+    bands: [78]
+    max_pdschReferenceSignalPower: -27
+    max_rxgain: 114
+    eNB_instances: [0]
+    bf_weights: [0x00007fff, 0x0000, 0x0000, 0x0000]
+    clock_src: internal
+
+rfsimulator:
+  serveraddr: server
+  serverport: 4043
+  options: [] #("saviq"); or/and "chanmod"
+  modelname: AWGN
+  IQfile: /tmp/rfsimulator.iqs
+
+security:
+  # preferred ciphering algorithms
+  # the first one of the list that an UE supports in chosen
+  # valid values: nea0, nea1, nea2, nea3
+  ciphering_algorithms: [nea0]
+
+  # preferred integrity algorithms
+  # the first one of the list that an UE supports in chosen
+  # valid values: nia0, nia1, nia2, nia3
+  integrity_algorithms: [nia2, nia0]
+
+  # setting 'drb_ciphering' to "no" disables ciphering for DRBs, no matter
+  # what 'ciphering_algorithms' configures; same thing for 'drb_integrity'
+  drb_ciphering: yes
+  drb_integrity: no
+
+log_config:
+  global_log_level: info
+  hw_log_level: info
+  phy_log_level: info
+  mac_log_level: info
+  rlc_log_level: info
+  pdcp_log_level: info
+  rrc_log_level: info
+  ngap_log_level: debug
+  f1ap_log_level: debug
+
+e2_agent:
+  near_ric_ip_addr: 127.0.0.1
+  #sm_dir = /path/where/the/SMs/are/located/
+  sm_dir: /usr/local/lib/flexric/