From 753a664c0654711574be4d50124f5dd48d71efb5 Mon Sep 17 00:00:00 2001 From: Rajeev Gangula Date: Tue, 25 Sep 2018 15:07:22 +0200 Subject: [PATCH 01/25] Corrected PHR calculation. --- openair2/LAYER2/MAC/eNB_scheduler_ulsch.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/openair2/LAYER2/MAC/eNB_scheduler_ulsch.c b/openair2/LAYER2/MAC/eNB_scheduler_ulsch.c index 31c11e2c0a..0ae1b8255e 100644 --- a/openair2/LAYER2/MAC/eNB_scheduler_ulsch.c +++ b/openair2/LAYER2/MAC/eNB_scheduler_ulsch.c @@ -298,7 +298,10 @@ rx_sdu(const module_id_t enb_mod_idP, case POWER_HEADROOM: if (UE_id != -1) { UE_list->UE_template[CC_idP][UE_id].phr_info = - (payload_ptr[0] & 0x3f) - PHR_MAPPING_OFFSET; + (payload_ptr[0] & 0x3f) - PHR_MAPPING_OFFSET + (int8_t)(hundred_times_log10_NPRB[UE_list->UE_template[CC_idP][UE_id].nb_rb_ul[harq_pid]-1]/100); + if(UE_list->UE_template[CC_idP][UE_id].phr_info > 40) + UE_list->UE_template[CC_idP][UE_id].phr_info = 40; + LOG_D(MAC, "[eNB %d] CC_id %d MAC CE_LCID %d : Received PHR PH = %d (db)\n", enb_mod_idP, CC_idP, rx_ces[i], From 74dc481133519e06ad236b1406d051c11522575e Mon Sep 17 00:00:00 2001 From: Cedric Roux Date: Tue, 6 Nov 2018 16:50:48 +0100 Subject: [PATCH 02/25] bladeRF: have it functional with libbladerf 2.0 Not much has been changed in the driver (that used libbladerf 1.0). Some bugs have been fixed. Documentation has been added. A configuration file has been added too, put in the directory ./configuration/bladeRF. To use a bladeRF device, see documentation in targets/ARCH/BLADERF/README. Only the BladeRF x40 has been tested. Performance is not too bad at 5MHz, a bit worse at 10MHz and on the test machine I used I face realtime problems at 20MHz when I push downlink throughput. So, there is still some work to do to have a good support of bladeRF. --- configuration/bladeRF/enb-band7-5mhz.conf | 274 ++++++++++++++++++ targets/ARCH/BLADERF/README | 138 +++++++++ .../ARCH/BLADERF/USERSPACE/LIB/bladerf_lib.c | 43 ++- 3 files changed, 431 insertions(+), 24 deletions(-) create mode 100644 configuration/bladeRF/enb-band7-5mhz.conf create mode 100644 targets/ARCH/BLADERF/README diff --git a/configuration/bladeRF/enb-band7-5mhz.conf b/configuration/bladeRF/enb-band7-5mhz.conf new file mode 100644 index 0000000000..6e07b8d949 --- /dev/null +++ b/configuration/bladeRF/enb-band7-5mhz.conf @@ -0,0 +1,274 @@ +Active_eNBs = ( "eNB-Eurecom-LTEBox"); +# Asn1_verbosity, choice in: none, info, annoying +Asn1_verbosity = "none"; + +eNBs = +( + { + # real_time choice in {hard, rt-preempt, no} + real_time = "no"; + ////////// Identification parameters: + eNB_ID = 0xe00; + + cell_type = "CELL_MACRO_ENB"; + + eNB_name = "eNB-Eurecom-LTEBox"; + + // Tracking area code, 0x0000 and 0xfffe are reserved values + tracking_area_code = 1; + plmn_list = ( + { mcc = 208; mnc = 92; mnc_length = 2; } + ); + + tr_s_preference = "local_mac" + + ////////// Physical parameters: + + component_carriers = ( + { + node_function = "eNodeB_3GPP"; + node_timing = "synch_to_ext_device"; + node_synch_ref = 0; + nb_antenna_ports = 1; + ue_TransmissionMode = 1; + frame_type = "FDD"; + tdd_config = 3; + tdd_config_s = 0; + prefix_type = "NORMAL"; + eutra_band = 7; + downlink_frequency = 2680000000L; + uplink_frequency_offset = -120000000; + + Nid_cell = 0; + N_RB_DL = 25; + Nid_cell_mbsfn = 0; + nb_antennas_tx = 1; + nb_antennas_rx = 1; + prach_root = 0; + tx_gain = 90; + rx_gain = 115; + pbch_repetition = "FALSE"; + prach_config_index = 0; + prach_high_speed = "DISABLE"; + prach_zero_correlation = 1; + prach_freq_offset = 2; + pucch_delta_shift = 1; + pucch_nRB_CQI = 0; + pucch_nCS_AN = 0; + pucch_n1_AN = 0; + pdsch_referenceSignalPower = -29; + pdsch_p_b = 0; + pusch_n_SB = 1; + pusch_enable64QAM = "DISABLE"; + pusch_hoppingMode = "interSubFrame"; + pusch_hoppingOffset = 0; + pusch_groupHoppingEnabled = "ENABLE"; + pusch_groupAssignment = 0; + pusch_sequenceHoppingEnabled = "DISABLE"; + pusch_nDMRS1 = 1; + phich_duration = "NORMAL"; + phich_resource = "ONESIXTH"; + srs_enable = "DISABLE"; + /* srs_BandwidthConfig =; + srs_SubframeConfig =; + srs_ackNackST =; + srs_MaxUpPts =;*/ + + pusch_p0_Nominal = -96; + pusch_alpha = "AL1"; + pucch_p0_Nominal = -108; + msg3_delta_Preamble = 6; + pucch_deltaF_Format1 = "deltaF2"; + pucch_deltaF_Format1b = "deltaF3"; + pucch_deltaF_Format2 = "deltaF0"; + pucch_deltaF_Format2a = "deltaF0"; + pucch_deltaF_Format2b = "deltaF0"; + + rach_numberOfRA_Preambles = 64; + rach_preamblesGroupAConfig = "DISABLE"; +/* + rach_sizeOfRA_PreamblesGroupA = ; + rach_messageSizeGroupA = ; + rach_messagePowerOffsetGroupB = ; +*/ + rach_powerRampingStep = 4; + rach_preambleInitialReceivedTargetPower = -108; + rach_preambleTransMax = 10; + rach_raResponseWindowSize = 10; + rach_macContentionResolutionTimer = 48; + rach_maxHARQ_Msg3Tx = 4; + + pcch_default_PagingCycle = 128; + pcch_nB = "oneT"; + bcch_modificationPeriodCoeff = 2; + ue_TimersAndConstants_t300 = 1000; + ue_TimersAndConstants_t301 = 1000; + ue_TimersAndConstants_t310 = 1000; + ue_TimersAndConstants_t311 = 10000; + ue_TimersAndConstants_n310 = 20; + ue_TimersAndConstants_n311 = 1; + + //Parameters for SIB18 + rxPool_sc_CP_Len = "normal"; + rxPool_sc_Period = "sf40"; + rxPool_data_CP_Len = "normal"; + rxPool_ResourceConfig_prb_Num = 20; + rxPool_ResourceConfig_prb_Start = 5; + rxPool_ResourceConfig_prb_End = 44; + rxPool_ResourceConfig_offsetIndicator_present = "prSmall"; + rxPool_ResourceConfig_offsetIndicator_choice = 0; + rxPool_ResourceConfig_subframeBitmap_present = "prBs40"; + rxPool_ResourceConfig_subframeBitmap_choice_bs_buf = "00000000000000000000"; + rxPool_ResourceConfig_subframeBitmap_choice_bs_size = 5; + rxPool_ResourceConfig_subframeBitmap_choice_bs_bits_unused = 0; +/* rxPool_dataHoppingConfig_hoppingParameter = 0; + rxPool_dataHoppingConfig_numSubbands = "ns1"; + rxPool_dataHoppingConfig_rbOffset = 0; + rxPool_commTxResourceUC-ReqAllowed = "TRUE"; +*/ + // Parameters for SIB19 + discRxPool_cp_Len = "normal" + discRxPool_discPeriod = "rf32" + discRxPool_numRetx = 1; + discRxPool_numRepetition = 2; + discRxPool_ResourceConfig_prb_Num = 5; + discRxPool_ResourceConfig_prb_Start = 3; + discRxPool_ResourceConfig_prb_End = 21; + discRxPool_ResourceConfig_offsetIndicator_present = "prSmall"; + discRxPool_ResourceConfig_offsetIndicator_choice = 0; + discRxPool_ResourceConfig_subframeBitmap_present = "prBs40"; + discRxPool_ResourceConfig_subframeBitmap_choice_bs_buf = "f0ffffffff"; + discRxPool_ResourceConfig_subframeBitmap_choice_bs_size = 5; + discRxPool_ResourceConfig_subframeBitmap_choice_bs_bits_unused = 0; + + } + ); + + srb1_parameters : + { + # timer_poll_retransmit = (ms) [5, 10, 15, 20,... 250, 300, 350, ... 500] + timer_poll_retransmit = 80; + + # timer_reordering = (ms) [0,5, ... 100, 110, 120, ... ,200] + timer_reordering = 35; + + # timer_reordering = (ms) [0,5, ... 250, 300, 350, ... ,500] + timer_status_prohibit = 0; + + # poll_pdu = [4, 8, 16, 32 , 64, 128, 256, infinity(>10000)] + poll_pdu = 4; + + # poll_byte = (kB) [25,50,75,100,125,250,375,500,750,1000,1250,1500,2000,3000,infinity(>10000)] + poll_byte = 99999; + + # max_retx_threshold = [1, 2, 3, 4 , 6, 8, 16, 32] + max_retx_threshold = 4; + } + + # ------- SCTP definitions + SCTP : + { + # Number of streams to use in input/output + SCTP_INSTREAMS = 2; + SCTP_OUTSTREAMS = 2; + }; + + ////////// MME parameters: + mme_ip_address = ( { ipv4 = "192.168.12.148"; + ipv6 = "192:168:30::17"; + active = "yes"; + preference = "ipv4"; + } + ); + + NETWORK_INTERFACES : + { + ENB_INTERFACE_NAME_FOR_S1_MME = "eth1"; + ENB_IPV4_ADDRESS_FOR_S1_MME = "192.168.12.196/24"; + + ENB_INTERFACE_NAME_FOR_S1U = "eth1"; + ENB_IPV4_ADDRESS_FOR_S1U = "192.168.12.196/24"; + ENB_PORT_FOR_S1U = 2152; # Spec 2152 + + ENB_IPV4_ADDRESS_FOR_X2C = "192.168.12.196/24"; + ENB_PORT_FOR_X2C = 36422; # Spec 36422 + }; + + log_config : + { + global_log_level ="info"; + global_log_verbosity ="high"; + hw_log_level ="info"; + hw_log_verbosity ="medium"; + phy_log_level ="info"; + phy_log_verbosity ="medium"; + mac_log_level ="info"; + mac_log_verbosity ="high"; + rlc_log_level ="debug"; + rlc_log_verbosity ="high"; + pdcp_log_level ="info"; + pdcp_log_verbosity ="high"; + rrc_log_level ="info"; + rrc_log_verbosity ="medium"; + }; + + } +); + +MACRLCs = ( + { + num_cc = 1; + tr_s_preference = "local_L1"; + tr_n_preference = "local_RRC"; + phy_test_mode = 0; + puSch10xSnr = 210; + puCch10xSnr = 210; + } +); + +THREAD_STRUCT = ( + { + parallel_config = "PARALLEL_RU_L1_TRX_SPLITaaaaaa"; + worker_config = "ENABLE"; + } +); + +L1s = ( + { + num_cc = 1; + tr_n_preference = "local_mac"; + } +); + +RUs = ( + { + local_rf = "yes" + nb_tx = 1 + nb_rx = 1 + att_tx = 73 + att_rx = 0; + bands = [7]; + max_pdschReferenceSignalPower = -28; + max_rxgain = 96; + eNB_instances = [0]; + + } +); + + log_config : + { + global_log_level ="info"; + global_log_verbosity ="high"; + hw_log_level ="info"; + hw_log_verbosity ="medium"; + phy_log_level ="info"; + phy_log_verbosity ="medium"; + mac_log_level ="info"; + mac_log_verbosity ="high"; + rlc_log_level ="info"; + rlc_log_verbosity ="high"; + pdcp_log_level ="info"; + pdcp_log_verbosity ="high"; + rrc_log_level ="info"; + rrc_log_verbosity ="medium"; + }; diff --git a/targets/ARCH/BLADERF/README b/targets/ARCH/BLADERF/README new file mode 100644 index 0000000000..c93c938baf --- /dev/null +++ b/targets/ARCH/BLADERF/README @@ -0,0 +1,138 @@ +BladeRF documentation +===================== + +As of 2018-11-06, the bladeRF support is not fully automatic and requires +some manual settings before use. This documentation is the ultimate source +of information. If something described in this file does not work or does +not correspond to the reality, then contact us so we can fix the problems +and update this documentation. + +1. Install bladeRF 2.0 libraries. + + As of now, it's better to install from source. + So, do not run: ./build_oai -I -w BLADERF + (That is: do not include '-w BLADERF'.) + + Instead, follow the instructions at: https://github.com/Nuand/bladeRF + + If you already had some bladeRF software installed using automatic + methods, first remove it by hand ('apt-get purge bladeRF' or something + similar, you can get the list of installed bladeRF packages by running + 'dpkg -l|grep -i blade', remove them all). + +2. Update the device. + + Download the latest FX3 firmware and FPGA images from Nuand's website. + As of writing, this is: + + https://github.com/Nuand/bladeRF/wiki + + That points to the following pages. + For FX3: + + http://www.nuand.com/fx3_images/ + + For FPGA: + + http://www.nuand.com/fpga_images/ + + Install FX3 firmware: + + sudo bladeRF-cli -f bladeRF_fw_latest.img + + Install FPGA image (this is for BladeRF x40): + + sudo bladeRF-cli -L hostedx40-latest.rbf + + Retrieve calibration information: + + sudo bladeRF-cli -i + info + + That outputs the serial number of your device. + + Go to: + + https://www.nuand.com/calibration + + And enter your serial number. + The website tells you to run something like: + + sudo bladeRF-cli -i + flash_init_cal 40 0x9271 + + Actual values depend on your device and serial number. + +3. Calibrate the bladeRF device. + + We will work with band 7 on 2.68GHz with a bandwidth of 5 MHz (25 RBs). + + Plug the bladeRF device, then run: + + sudo bladeRF-cli -i + set frequency tx 2680000000 + set frequency rx 2560000000 + set gain rx 60 + set gain tx 60 + set bandwidth 5000000 + set samplerate 7680000 + cal lms + cal lms + cal lms + cal dc rxtx + cal dc rxtx + cal dc rxtx + +4. Tune the RX gain using the enb tracer. + + Run the softmodem and the 'enb' tracer. For instructions, see: + + https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/T/basic + + In the enb window, check the 'input signal'. You should see some blue + signal as seen at: + + https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/T/enb + + (the 'Time signal power' plot). + + The level should be around 30. + + If it's not around 30 then edit your configuration file and modify + the value 'max_rxgain' in the section 'RUs'. + + The configuration file to use is: + + configuration/bladeRF/enb-band7-5mhz.conf + + In the configuration file, you also need to set the correct values for: + + - tracking_area_code + - plmn_list: mcc, mnc, mnc_length + - mme_ip_address: this is the IP address used by the computer running + the softmodem to connect to the EPC + - NETWORK_INTERFACES: all the ENB*ADDRESS* variables have to point + to the IP address of the EPC machine + +5. You're good to go. + + You can now connect a UE and pass some traffic. If everything is well + configured you can expect more than 16 Mb/s of throughput in the downlink + using iperf and more than 8 Mb/s in the uplink. Looking at the logs, you + should find lines containing 'PHR 40' and 'CQI 15'. If your values are + lower then your setup may need some adjustments. + +6. In case of problems. + + If the performance of the softmodem is very bad, you can stop it and + run the calibration again, without setting the parameters (frequencies, + gains, etc.). Just run: + + sudo bladeRF-cli -i + cal lms + cal dc rxtx + + That may help. + + Be sure to use proper radio equipment (duplexer, antennas, clean + environment without interferences). diff --git a/targets/ARCH/BLADERF/USERSPACE/LIB/bladerf_lib.c b/targets/ARCH/BLADERF/USERSPACE/LIB/bladerf_lib.c index 75a7825669..e5966af267 100644 --- a/targets/ARCH/BLADERF/USERSPACE/LIB/bladerf_lib.c +++ b/targets/ARCH/BLADERF/USERSPACE/LIB/bladerf_lib.c @@ -116,15 +116,6 @@ int trx_brf_start(openair0_device *device) { abort(); } - if ((status=bladerf_calibrate_dc(brf->dev, BLADERF_MODULE_TX)) != 0) { - fprintf(stderr,"Failed to calibrate TX DC: %s\n", bladerf_strerror(status)); - abort(); - } - if ((status=bladerf_calibrate_dc(brf->dev, BLADERF_MODULE_RX)) != 0) { - fprintf(stderr,"Failed to calibrate RX DC: %s\n", bladerf_strerror(status)); - abort(); - } - return 0; } @@ -235,8 +226,6 @@ static int trx_brf_read(openair0_device *device, openair0_timestamp *ptimestamp, * \param device the hardware to use */ void trx_brf_end(openair0_device *device) { -abort(); - int status; brf_state_t *brf = (brf_state_t*)device->priv; // Disable RX module, shutting down our underlying RX stream @@ -247,6 +236,7 @@ abort(); fprintf(stderr, "Failed to disable TX module: %s\n", bladerf_strerror(status)); } bladerf_close(brf->dev); + exit(1); } /*! \brief print the BladeRF statistics @@ -362,6 +352,8 @@ void set_rx_gain_offset(openair0_config_t *openair0_cfg, int chain_index) { */ void calibrate_rf(openair0_device *device) { + /* TODO: this function does not seem to work. Disabled until fixed. */ + return; brf_state_t *brf = (brf_state_t *)device->priv; openair0_timestamp ptimestamp; @@ -1005,6 +997,12 @@ int device_init(openair0_device *device, openair0_config_t *openair0_cfg) { // RX // Example of CLI output: RX Frequency: 2539999999Hz + + if ((status=bladerf_set_gain_mode(brf->dev, BLADERF_MODULE_RX, BLADERF_GAIN_MGC))) { + fprintf(stderr, "[BRF] Failed to disable AGC\n"); + brf_error(status); + } + if ((status=bladerf_set_frequency(brf->dev, BLADERF_MODULE_RX, (unsigned int) openair0_cfg->rx_freq[0])) != 0){ fprintf(stderr,"Failed to set RX frequency: %s\n",bladerf_strerror(status)); brf_error(status); @@ -1096,17 +1094,14 @@ int device_init(openair0_device *device, openair0_config_t *openair0_cfg) { // calibrate - if ((status=bladerf_calibrate_dc(brf->dev, BLADERF_MODULE_TX)) != 0) { - fprintf(stderr,"Failed to calibrate TX DC: %s\n", bladerf_strerror(status)); + if ((status=bladerf_calibrate_dc(brf->dev, BLADERF_DC_CAL_LPF_TUNING)) != 0 || + (status=bladerf_calibrate_dc(brf->dev, BLADERF_DC_CAL_TX_LPF)) != 0 || + (status=bladerf_calibrate_dc(brf->dev, BLADERF_DC_CAL_RX_LPF)) != 0 || + (status=bladerf_calibrate_dc(brf->dev, BLADERF_DC_CAL_RXVGA2)) != 0) { + fprintf(stderr, "[BRF] error calibrating\n"); brf_error(status); - } else - printf("[BRF] TX module calibrated DC \n"); - - if ((status=bladerf_calibrate_dc(brf->dev, BLADERF_MODULE_RX)) != 0) { - fprintf(stderr,"Failed to calibrate RX DC: %s\n", bladerf_strerror(status)); - brf_error(status); - }else - printf("[BRF] RX module calibrated DC \n"); + } else + printf("[BRF] calibration OK\n"); bladerf_log_set_verbosity(get_brf_log_level(openair0_cfg->log_level)); @@ -1146,8 +1141,8 @@ int device_init(openair0_device *device, openair0_config_t *openair0_cfg) { * \returns 0 on success */ int brf_error(int status) { - - //exit(-1); + fprintf(stderr, "[BRF] brf_error: %s\n", bladerf_strerror(status)); + exit(-1); return status; // or status error code } @@ -1190,7 +1185,7 @@ struct bladerf * open_bladerf_from_serial(const char *serial) { int get_brf_log_level(int log_level){ int level=BLADERF_LOG_LEVEL_INFO; - return BLADERF_LOG_LEVEL_DEBUG; // BLADERF_LOG_LEVEL_VERBOSE;// BLADERF_LOG_LEVEL_DEBUG; // + return BLADERF_LOG_LEVEL_INFO; switch(log_level) { case LOG_DEBUG: level=BLADERF_LOG_LEVEL_DEBUG; From 3515d4316f18417412012bc9264a8c661a1192ae Mon Sep 17 00:00:00 2001 From: frtabu Date: Thu, 8 Nov 2018 19:10:49 +0100 Subject: [PATCH 03/25] doc for config module moved from wiki --- common/config/DOC/config.md | 11 ++ common/config/DOC/config/arch.md | 7 + common/config/DOC/config/devusage.md | 20 +++ .../config/DOC/config/devusage/addaparam.md | 86 ++++++++++++ .../config/DOC/config/devusage/addparamset.md | 131 ++++++++++++++++++ common/config/DOC/config/devusage/api.md | 48 +++++++ common/config/DOC/config/devusage/struct.md | 85 ++++++++++++ common/config/DOC/config/rtusage.md | 52 +++++++ common/utils/DOC/loader.md | 17 +++ common/utils/DOC/loader/arch.md | 7 + common/utils/DOC/loader/devusage.md | 17 +++ common/utils/DOC/loader/devusage/api.md | 20 +++ common/utils/DOC/loader/devusage/loading.md | 56 ++++++++ common/utils/DOC/loader/devusage/struct.md | 10 ++ common/utils/DOC/loader/rtusage.md | 50 +++++++ common/utils/telnetsrv/DOC/telnetaddcmd.md | 116 ++++++++++++++++ common/utils/telnetsrv/DOC/telnetarch.md | 21 +++ common/utils/telnetsrv/DOC/telnetgetset.md | 21 +++ common/utils/telnetsrv/DOC/telnethelp.md | 57 ++++++++ common/utils/telnetsrv/DOC/telnethist.md | 44 ++++++ common/utils/telnetsrv/DOC/telnetloader.md | 47 +++++++ common/utils/telnetsrv/DOC/telnetlog.md | 95 +++++++++++++ common/utils/telnetsrv/DOC/telnetloop.md | 40 ++++++ common/utils/telnetsrv/DOC/telnetsrv.md | 7 + common/utils/telnetsrv/DOC/telnetusage.md | 39 ++++++ 25 files changed, 1104 insertions(+) create mode 100644 common/config/DOC/config.md create mode 100644 common/config/DOC/config/arch.md create mode 100644 common/config/DOC/config/devusage.md create mode 100644 common/config/DOC/config/devusage/addaparam.md create mode 100644 common/config/DOC/config/devusage/addparamset.md create mode 100644 common/config/DOC/config/devusage/api.md create mode 100644 common/config/DOC/config/devusage/struct.md create mode 100644 common/config/DOC/config/rtusage.md create mode 100644 common/utils/DOC/loader.md create mode 100644 common/utils/DOC/loader/arch.md create mode 100644 common/utils/DOC/loader/devusage.md create mode 100644 common/utils/DOC/loader/devusage/api.md create mode 100644 common/utils/DOC/loader/devusage/loading.md create mode 100644 common/utils/DOC/loader/devusage/struct.md create mode 100644 common/utils/DOC/loader/rtusage.md create mode 100644 common/utils/telnetsrv/DOC/telnetaddcmd.md create mode 100644 common/utils/telnetsrv/DOC/telnetarch.md create mode 100644 common/utils/telnetsrv/DOC/telnetgetset.md create mode 100644 common/utils/telnetsrv/DOC/telnethelp.md create mode 100644 common/utils/telnetsrv/DOC/telnethist.md create mode 100644 common/utils/telnetsrv/DOC/telnetloader.md create mode 100644 common/utils/telnetsrv/DOC/telnetlog.md create mode 100644 common/utils/telnetsrv/DOC/telnetloop.md create mode 100644 common/utils/telnetsrv/DOC/telnetsrv.md create mode 100644 common/utils/telnetsrv/DOC/telnetusage.md diff --git a/common/config/DOC/config.md b/common/config/DOC/config.md new file mode 100644 index 0000000000..682780cd3b --- /dev/null +++ b/common/config/DOC/config.md @@ -0,0 +1,11 @@ +# OAI configuration module + +The configuration module provides an api that other oai components can use to get parameters at init time. It defines a parameter structure, used to describe parameters attributes (for example name and type). The same structure includes a pointer to the variable where the configuration module writes the parameter value, at run time, when calling config_get or config_getlist functions. For each parameter a function to check the value can be specified and pre-defined functions are provided for some common parameter validations (integer in a range or in a list, string in a list). The module also include a mechanism to check that no unknown options have been entered on the command line + +## Documentation + +* [runtime usage](config/rtusage) +* [developer usage](config/devusage) +* [module architecture](config/arch) + +[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home) diff --git a/common/config/DOC/config/arch.md b/common/config/DOC/config/arch.md new file mode 100644 index 0000000000..efe4d9eef7 --- /dev/null +++ b/common/config/DOC/config/arch.md @@ -0,0 +1,7 @@ +# config module source files +![configmodule_srcdir](/uploads/fdc3e96011fd5592440900dfa05b4701/configmodule_srcdir.png) +# config module components +![configmodule_components](/uploads/54f8a3953d5ee53717cd9a3b71f85c68/configmodule_components.png) + + +[Configuration module home](config) \ No newline at end of file diff --git a/common/config/DOC/config/devusage.md b/common/config/DOC/config/devusage.md new file mode 100644 index 0000000000..88abc96f42 --- /dev/null +++ b/common/config/DOC/config/devusage.md @@ -0,0 +1,20 @@ +The configuration module objectives are +1. Allow easy parameters management in oai, helping the development of a flexible, modularized and fully configurable softmodem. +1. Use a common configuration API in all oai modules +1. Allow development of alternative configuration sources without modifying the oai code. Today the only delivered configuration source is the libconfig format configuration file. + +As a developer you may need to look at these sections: + +* [add parameters in an existing section](config/devusage/addaparam) +* [add a parameter set, in a new section](config/devusage/addparamset) +* [configuration module API](config/devusage/api) +* [configuration module public structures](config/devusage/struct) + +Whatever your need is, configuration module usage examples can be found in oai sources: +* complex example, using all the configuration module functionalities, including parameter checking: +[NB-IoT configuration code](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/ENB_APP/NB_IoT_config.c) and [NB-IoT configuration include file](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/ENB_APP/NB_IoT_paramdef.h) +* very simple example, just reading a parameter set corresponding to a dedicated section: the telnetsrv_autoinit function in [common/utils/telnetsrv/telnetsrv.c, around line 726](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv.c#L726) +* an example with run-time definition of parameters, in the logging sub-system: the log_getconfig function at the top of [openair2/UTIL/LOG/log.c](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/UTIL/LOG/log.c) + + +[Configuration module home](config) diff --git a/common/config/DOC/config/devusage/addaparam.md b/common/config/DOC/config/devusage/addaparam.md new file mode 100644 index 0000000000..28bd3ee142 --- /dev/null +++ b/common/config/DOC/config/devusage/addaparam.md @@ -0,0 +1,86 @@ +To add a new parameter in an existing section you insert an item in a `paramdef_t` array, which describes the parameters to be read in the existing `config_get` call. You also need to increment the numparams argument. + +existing code: +```c +unsigned int varopt1; +paramdef_t someoptions[] = { +/*---------------------------------------------------------------------------------*/ +/* configuration parameters for some module */ +/* optname helpstr paramflags XXXptr defXXXval type numelt */ +/*---------------------------------------------------------------------------------*/ + {"opt1", "", 0, uptr:&varopt1, defuintval:0, TYPE_UINT, 0 }, +}; + +config_get( someoptions,sizeof(someoptions)/sizeof(paramdef_t),"somesection"); + +``` +new code: +```c +unsigned int varopt1; + + +/* varopt2 will be allocated by the config module and free at end_configmodule call + except if PARAMFLAG_NOFREE bit is set in paramflags field*/ +char *varopt2; +paramdef_t someoptions[] = { +/*---------------------------------------------------------------------------------*/ +/* configuration parameters for some module */ +/* optname helpstr paramflags XXXptr defXXXval type numelt */ +/*---------------------------------------------------------------------------------*/ + {"opt1", "", 0, uptr:&varopt1, defuintval:0,TYPE_UINT, 0 }, + {"opt2", "", 0, strptr:&varopt2,defstrval:"",TYPE_STRING,0 }, +}; + +config_get( someoptions,sizeof(someoptions)/sizeof(paramdef_t),"somesection"); + +``` + +The corresponding configuration file may now include opt2 parameter in the somesection section: + +```c +somesection = +{ +opt1 = 3; +opt2 = "abcd"; +}; +``` + +In these examples the variables used to retrieve the parameters values are pointed by the `uptr` or `strptr` fields of the `paramdef_t` structure. After the `config_get` call `varopt1` and `varopt2` have been set to the value specified in the config file. It is also possible to specify a `NULL` value to the `< XXX >ptr` fields, which are then allocated by the config module and possibly free when calling `config_end()`, if the `PARAMFLAG_NOFREE` bit has not been set in the `paramflags` field. + +The configuration module provides a mechanism to check the parameter value read from the configuration source. The following functions are implemented: +1. Check an integer parameter against a list of authorized values +1. Check an integer parameter against a list of authorized values and set the parameter to a new value +1. Check an integer parameter against a range +1. Check a C string parameter against a list of authorized values +1. Check a C string parameter against a list of authorized values and set the parameter to a new integer value + + A `checkedparam_t` structure array provides the parameter verification procedures: + +```c +/* + definition of the verification to be done on param opt1 and opt2. + opt1 is an integer option we must be set to 0,2,3,4 or 7 in the + config source. + if opt1 is set to 0 in the config file, it will be set to 1, etc + opt2 is C string option with the authorize values "zero","oneThird","twoThird","one" + */ +#define OPT1_OKVALUES {0,2,3,4,7} +#define OPT1_NEWVALUES {1,1,0,6,9} +#define OPT2_OKVALUES {"zero","oneThird","twoThird","one"} + +#define OPT_CHECK_DESC { \ + { .s1a= { config_check_modify_integer, OPT1_OKVALUE, OPT1_NEWVALUES ,5 }}, \ + { .s3= { config_check_strval, OPT2_OKVALUES,4 }}, \ +} +checkedparam_t checkopt[] = OPT_CHECK_DESC; +..... +/* assign the verification procedures to the parameters definitions */ +for(int i=0 ; i < sizeof(someoptions)/sizeof(paramdesc_t) ; i ++) { + someoptions[i].chkPptr = &(checkopt[i]); +} +.... +``` +When you need a specific verification algorithm, you can provide your own verification function and use it in place of the available ones, in the `checkedparam_t` union. If no existing structure definition match your need, you can enhance the configuration module. You then have to add a new verification function in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_userapi.c and add a new structure definition in the `checkedparam_t` type defined in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h + +[Configuration module developer main page](config/devusage) +[Configuration module home](config) diff --git a/common/config/DOC/config/devusage/addparamset.md b/common/config/DOC/config/devusage/addparamset.md new file mode 100644 index 0000000000..9b90fcc81f --- /dev/null +++ b/common/config/DOC/config/devusage/addparamset.md @@ -0,0 +1,131 @@ +The configuration module maps a configuration file section to a `paramdef_t` structure array. One `config_get` call can be used to return the values of all the parameters described in the `paramdef_t` array. +Retrieving a single occurence of a parameter set ( a group in the libconfig terminology) is just a two steps task: +1. describe the parameters in a `paramdef_t` array +1. call the `config_get` function + + +[config_get example](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/config/devusage/addaparam) + + +In oai some parameters set may be instantiated a variable number of occurrences. In a configuration file this is mapped to lists of group of parameters, with this syntax: +```c +NB-IoT_MACRLCs = +/* start list element 1 */ +( + /* start a group of parameters */ + { + num_cc = 2; + ..... + remote_s_portd = 55001; + } +), +/* start list element 2 */ +( + /* start a group of parameters */ + { + num_cc = 1; + ...... + remote_s_portd = 65001; + } +); + +``` +The configuration module provides the `config_getlist` call to support lists of group of parameters. Below is a commented code example, using the config_getlist call. + +```c +/* name of section containing the list */ +#define NBIOT_MACRLCLIST_CONFIG_STRING "NB-IoT_MACRLCs" + +/* +The following macro define the parameters names, as used in the +configuration file +*/ +#define CONFIG_STRING_MACRLC_CC "num_cc" +..... +#define CONFIG_MACRLC_S_PORTD "remote_s_portd" + +/* + now define a macro which will be used to initialize the NbIoT_MacRLC_Params + variable. NbIoT_MacRLC_Params is an array of paramdef_t structure, each item + describing a parameter. When using the config_getlist call you must let the config + module allocate the memory for the parameters values. +*/ +/*------------------------------------------------------------------------------------------------------------*/ +/* optname helpstr paramflags XXXptr defXXXval type numelt */ +/*------------------------------------------------------------------------------------------------------------*/ + +#define MACRLCPARAMS_DESC { \ +{CONFIG_STRING_MACRLC_CC, NULL, 0, uptr:NULL, defintval:1, TYPE_UINT, 0}, \ +............. \ +{CONFIG_MACRLC_S_PORTD, NULL, 0, uptr:NULL, defintval:50021, TYPE_UINT, 0}, \ +} + +/* +the following macros define the indexes used to access the NbIoT_MacRLC_Params array +items. They must be maintained consistent with the previous MACRLCPARAMS_DESC macro +which is used to initialize the NbIoT_MacRLC_Params variable +*/ +#define MACRLC_CC_IDX 0 +......... +#define MACRLC_REMOTE_S_PORTD_IDX 16 + + + +void RCconfig_NbIoTmacrlc(void) { + + +/* + define and initialize the array of paramdef_t structures describing the groups of + parameters we want to read. It will be passed as the second argument of the + config_getlist call, which will use it as an input only argument. +*/ + paramdef_t NbIoT_MacRLC_Params[] = MACRLCPARAMS_DESC; + +/* + now define and initialize a paramlist_def_t structure which will be passed + to the config_getlist call. The first field is the only one to be initialized + it contains the name of the section to be read. + that section contains the list of group of parameters. + The two other fields are output parameters used to return respectively + a pointer to a two dimensional array of paramdef_t structures pointers, and the + number of items in the list of groups (size of first dimension, the second one + being the number of parameters in each group. +*/ + paramlist_def_t NbIoT_MacRLC_ParamList = {NBIOT_MACRLCLIST_CONFIG_STRING,NULL,0}; + + + /* + the config_getlist will allocate the second field of the paramlist_def_t structure, a +two dimensional array of paramdef_t pointers. In each param_def item it will allocate +the value pointer and set the value to what it will get from the config source. The +numelt field of the paramlist_def_t structure will be set to the number of groups of +parameters in the list. + in this example the last argument of config_getlist is unused, it may contain a +character string, used as a prefix for the section name. It has to be specified when the +list to be read is under another section. +*/ + config_getlist( &NbIoT_MacRLC_ParamList,NbIoT_MacRLC_Params, + sizeof(NbIoT_MacRLC_Params)/sizeof(paramdef_t), + NULL); + +/* + start a loop in the nuber of groups in the list, the numelt field of the + paramlist_def_t structure has been set in the config_getlist call +*/ + for (j=0 ; jeth_params_s.remote_portd = + *(NbIoT_MacRLC_ParamList.paramarray[j][MACRLC_REMOTE_S_PORTD_IDX].iptr); +............ + + } // MacRLC_ParamList.numelt > 0 +} + + +``` + +[Configuration module developer main page](config/devusage) +[Configuration module home](config) diff --git a/common/config/DOC/config/devusage/api.md b/common/config/DOC/config/devusage/api.md new file mode 100644 index 0000000000..c9d562ced0 --- /dev/null +++ b/common/config/DOC/config/devusage/api.md @@ -0,0 +1,48 @@ +```c +configmodule_interface_t *load_configmodule(int argc, char **argv) +``` +* Parses the command line options, looking for the –O argument +* Loads the `libparams_.so` (today `libparams_libconfig.so`) shared library +* Looks for `config__init` symbol and calls it , passing it an array of string corresponding to the « : » separated strings used in the –O option +* Looks for `config__get`, `config__getlist` and `config__end` symbols which are the three functions a configuration library should implement. Get and getlist are mandatory, end is optional. +* Stores all the necessary information in a `configmodule_interface_t structure`, which is of no use for caller as long as we only use one configuration source. + +```c +void End_configmodule(void) +``` +* Free memory which has been allocated by the configuration module since its initialization. +* Possibly calls the `config__end` function + +```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__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 +* `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 + +```c +int config_libconfig_getlist(paramlist_def_t *ParamList, paramdef_t *params, int numparams, char *prefix) +``` +* Reads multiple occurrences of a parameters array +* Calls the `config__get` function for each list occurrence +* `params` points to an array of `paramdef_t` structures which describes the parameters in each occurrence of the list +* `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 + + +[Configuration module developer main page](config/devusage) +[Configuration module home](config) diff --git a/common/config/DOC/config/devusage/struct.md b/common/config/DOC/config/devusage/struct.md new file mode 100644 index 0000000000..17a9c36455 --- /dev/null +++ b/common/config/DOC/config/devusage/struct.md @@ -0,0 +1,85 @@ +# `paramdef_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#L103). This structure is used by developers to describe parameters and by the configuration module to return parameters value. A pointer to a `paramdef_t` array is passed to `config_get` and `config_getlist` calls to instruct the configuration module what parameters it should read. + +| Fields | Description | I/O | +|:-----------|:------------------------------------------------------------------|----:| +| `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 | +| `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 | +| `numelt` | For `TYPE_STRING` where `strptr` points to a preallocated string, this field must contain the size in bytes of the available memory. For all multiple values types, this field contains the number of values in the value field.| I/O | +| `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 | + +# `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. + +| Fields | Description | I/O | +|:-----------|:------------------------------------------------------------------|----:| +| `listname` | Name of the section containing the list, 63 bytes max (64 with trailing \0). It is used to prefix each paramater name when looking for its value. In the libconfig syntax, the parameter name full path build by the configuration module is: listname.[occurence index].optname. | I | +| `paramarray` | Pointer to an array of `ǹumelt` `paramdef_t` pointers. It is allocated by the configuration module and is used to return the parameters values. All input fields of each `paramdef_t` occurence are a copy of the `paramdef_t` argument passed to the `config_getlist` call. | O | +| `numelt` | Number of items in the `paramarray` field | O | + +# `checkedparam_t` union +It is defined in include file [ common/config/config_paramdesc.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h#L62). +This union of structures is used to provide a parameter checking mechanism. Each `paramdef_t` instance may include a pointer to a `checkedparam_t`structure which is then used by the configuration module to check the value it got from the config source. +Each structure in the union provides one parameter verification method, which returns `-1` when the verification fails. Currently the following structures are defined in the `checkedparam_t` union: + +| structure name | Description | +|:-----------|:------------------------------------------------------------------|----:| +| `s1` | check an integer against a list of authorized values | +| `s1a` | check an integer against a list of authorized values and set the parameter value to another integer depending on the read value| +| `s2` | check an integer against an authorized range, defined by its min and max value| +| `s3` | check a string against a list of authorized values | +| `s3a` | check a string against a list of authorized values and set the parameter value to an integer depending on the read value| +| `s4` | generic structure, to be used to provide a specific, not defined in the configuration module, verification algorithm | + +each of these structures provide the required fields to perform the specified parameter check. The first field is a pointer to a function, taking one argument, the `paramdef_t` structure describing the parameter to be checked. This function is called by the configuration module, in the `config_get` call , after the parameter value has been set, it then uses the other fields of the structure to perform the check. +The configuration module provides an implementation of the functions to be used to check parameters, qs described below. + +## `s1` structure +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f1` | pointer to the checking function. Initialize to `config_check_intval` to use the config module implementation | +| `okintval` | array of `CONFIG_MAX_NUMCHECKVAL` integers containing the authorized values | +| `num_okintval` | number of used values in `okintval` | + +## `s1a` structure +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f1a` | pointer to the checking function. Initialize to `config_check_modify_integer` to use the config module implementation | +| `okintval` | array of `CONFIG_MAX_NUMCHECKVAL` integers containing the authorized values | +| `setintval` | array of `CONFIG_MAX_NUMCHECKVAL` integers containing the values to be used for the parameter. The configuration module implementation set the parameter value to `setintval[i]` when the configured value is `okintval[i]` | +| `num_okintval` | number of used values in `okintval` and `setintval` | + +## `s2` structure +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f2` | pointer to the checking function. Initialize to `config_check_intrange` to use the config module implementation | +| `okintrange` | array of 2 integers containing the min and max values for the parameter | + +## `s3` structure +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f3` | pointer to the checking function. Initialize to `config_check_strval` to use the config module implementation | +| `okstrval` | array of `CONFIG_MAX_NUMCHECKVAL` C string pointers containing the authorized values | +| `num_okstrval` | number of used values in `okstrtval` | + + +## `s3a` structure +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f3a` | pointer to the checking function. Initialize to `config_checkstr_assign_integer` to use the config module implementation | +| `okstrval` | array of `CONFIG_MAX_NUMCHECKVAL` C string pointers containing the authorized values | +| `setintval` | array of `CONFIG_MAX_NUMCHECKVAL` integers containing the values to be used for the parameter. The configuration module implementation set the parameter value to `setintval[i]` when the configured value is `okstrval[i]` | +| `num_okstrval` | number of used values in `okintval` and `setintval` | + +## `s4` and `s5` structures +| field | Description | +|:-----------|:------------------------------------------------------------------| +| `f4` or `f5` | pointer to the checking function. they are generic structures to be used when no existing structure provides the required parameter verification. `f4` takes one argument, the `paramdef_t` structure corresponding to the parameter to be checked (`int (*f4)(paramdef_t *param)`), `f5` taxes no argument (`void (*checkfunc)(void)`) | + +[Configuration module developer main page](config/devusage) +[Configuration module home](config) diff --git a/common/config/DOC/config/rtusage.md b/common/config/DOC/config/rtusage.md new file mode 100644 index 0000000000..828f6a959d --- /dev/null +++ b/common/config/DOC/config/rtusage.md @@ -0,0 +1,52 @@ + + -O is the only mandatory command line option to start the eNodeb softmodem (lte-softmodem executable), it is used to specify the configuration source with the associated parameters: +```bash +$ ./lte-softmodem -O :::... +``` + The configuration module can also be used without a configuration source, ie to only parse the command line. In this case the -O switch is optional. This mode is used in the ue-softmodem executable and by the phy_simulators executables (ulsim, dlsim) + +Currently the available config sources are: + +- **libconfig**: libconfig file. [libconfig file format](http://www.hyperrealm.com/libconfig/libconfig_manual.html#Configuration-Files) Parameter1 is the file path and parameter 2 can be used to specify the level of console messages printed by the configuration module. +```bash +$ ./lte-softmodem -O libconfig::dbgl +``` +- **cmdlineonly**: command line only, the default mode for lte-uesoftmodem and the phy simiulators. In this case -O may be used to specify the config module debug level. + +The debug level is a mask: +* bit 1: print parameters values +* bit 2: print memory allocation/free performed by the config module +* bit 3: print command line processing messages +* bit 4: disable execution abort when parameters checking fails + +As a oai user, you may have to use bit 1 (dbgl1) , to check your configuration and get the full name of a parameter you would like to modify on the command line. Other bits are for developers usage, (dbgl7 will print all debug messages). + +```bash +$ ./lte-softmodem -O libconfig::dbgl1 +``` +```bash +$ ./lte-uesoftmodem -O cmdlineonly:dbgl1 +``` +For the lte-softmodem (the eNodeB) The config source parameter defaults to libconfig, preserving the initial -O option format. In this case you cannot specify the debug level. + +```bash +$ ./lte-softmodem -O +``` + +Configuration file parameters, except for the configuration file path, can be specified in a **config** section in the configuration file: + +``` +config: +{ + debugflags = 1; +} +``` +Configuration files examples can be found in the targets/PROJECTS/GENERIC-LTE-EPC/CONF sub-directory of the oai source tree. To minimize the number of configuration file to maintain, any parameter can also be specified on the command line. For example to modify the lte bandwidth to 20 MHz where the configuration file specifies 10MHz you can enter: + +```bash +$ ./lte-softmodem -O --eNBs.[0].component_carriers.[0].N_RB_DL 100 +``` + +As specified earlier, use the dbgl1 debug level to get the full name of a parameter you would like to modify on the command line. + +[Configuration module home](config) \ No newline at end of file diff --git a/common/utils/DOC/loader.md b/common/utils/DOC/loader.md new file mode 100644 index 0000000000..7ed23952aa --- /dev/null +++ b/common/utils/DOC/loader.md @@ -0,0 +1,17 @@ +# OAI shared library loader + +Shared libraries usage is modularization mechanism which provides the following advantages: +1. Prevents including in the main executable code which is not used in a given configuration +1. Provides flexibility, several implementation of a given functionality can be chosen at run-time, without any compilation step. For example you can build several devices (USRP, BladeFR, LimeSDR) and choose which one you want to use on the command line or via the configuration. +1. Makes code evolution easier: as soon as the shared library interface is clearly defined, you can work on the functionality implemented in a shared library while regularly updating the other components of the code. You can decide to develop your own version of a functionality, decide to deliver it or not, letting the user decide wwhat version he wants to use. + +The main drawback is a performance cost at init time, when loading libraries. + + +## Documentation + +* [runtime usage](loader/rtusage) +* [developer usage](loader/devusage) +* [module architecture](loader/arch) + +[oai Wikis home](home) \ No newline at end of file diff --git a/common/utils/DOC/loader/arch.md b/common/utils/DOC/loader/arch.md new file mode 100644 index 0000000000..53a1cc7ea2 --- /dev/null +++ b/common/utils/DOC/loader/arch.md @@ -0,0 +1,7 @@ +# loader source files + +The oai shared library loader is implemented in two source files, located in [common/utils](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils) +1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation +1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. + +[loader home page](loader) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage.md b/common/utils/DOC/loader/devusage.md new file mode 100644 index 0000000000..89d15aa75e --- /dev/null +++ b/common/utils/DOC/loader/devusage.md @@ -0,0 +1,17 @@ +The configuration module objectives are +1. Allow easy parameters management in oai, helping the development of a flexible, modularized and fully configurable softmodem. +1. Use a common configuration API in all oai modules +1. Allow development of alternative configuration sources without modifying the oai code. Today the only delivered configuration source is the libconfig format configuration file. + +As a developer you may need to look at these sections: + +* [loading a shared library](loader/devusage/loading) +* [loader API](loader/devusage/api) +* [loader public structures](loader/devusage/struct) + +Loader usage examples can be found in oai sources: + +* device and transport initialization code: [function `load_lib` in *targets/ARCH/COMMON/__common_lib.c__* ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/targets/ARCH/COMMON/common_lib.c#L91) +* turbo encoder and decoder initialization: [function `load_codinglib`in *openair1/PHY/CODING/__coding_load.c__*](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c#L113) + +[loader home page](loader) diff --git a/common/utils/DOC/loader/devusage/api.md b/common/utils/DOC/loader/devusage/api.md new file mode 100644 index 0000000000..e01d69e9d4 --- /dev/null +++ b/common/utils/DOC/loader/devusage/api.md @@ -0,0 +1,20 @@ + Loader API is defined in the [common/utils/load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/load_module_shlib.h) include file. +```c +int load_module_shlib(char *modname,loader_shlibfunc_t *farray, int numf) +``` +* possibly initializes the loader, if it has not been already initialized +* Formats the full shared library path, using the `modname` argument and the loader `shlibpath` and `shlibversion`configuration parameters. +* loads the shared library, using the dlopen system call +* looks for `< modname >_autoinit` symbol, using the `dlsym` system call and possibly call the corresponding function. +* looks for `< modname >_checkbuildver` symbol, using the `dlsym` system call and possibly calls the corresponding function. If the return value of this call is `-1`, program execution is stopped. It is the responsibility of the shared library developer to implement or not a `< modname >_checkbuildver` function and to decide if a version mismatch is a fatal condition. The `< modname >_checkbuildver` function must match the `checkverfunc_t` function type. The first argument is the main executable version, as set in the `PACKAGE_VERSION` macro defined in the [oai CMakeLists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt#L218), around line 218. The second argument points to the shared library version which should be set by the `< modname >_checkbuildver` function. +* If the farray pointer is null, looks for `< modname >_getfarray` symbol, calls the corresponding function when the symbol is found. `< modname >_getfarray` takes one argument, a pointer to a `loader_shlibfunc_t` array, and returns the number of items in this array, as defined by the `getfarrayfunc_t` type. The `loader_shlibfunc_t` array returned by the shared library must be fully filled (both `fname` and `fptr` fields). +* looks for the `numf` function symbols listed in the `farray[i].fname` arguments and set the corresponding `farray[i].fptr`function pointers + + +```c +void * get_shlibmodule_fptr(char *modname, char *fname) +``` +Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. + +[loader home page](loader) +[loader developer home page](loader/devusage) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/loading.md b/common/utils/DOC/loader/devusage/loading.md new file mode 100644 index 0000000000..e544830c03 --- /dev/null +++ b/common/utils/DOC/loader/devusage/loading.md @@ -0,0 +1,56 @@ +Implementing a shared library dynamic load using the oai loader is a two steps task: +1. define the `loader_shlibfunc_t` array, describing the list of externally available functions implemented in the library. This is the interface of the module. +1. Call the `load_module_shlib` function, passing it the previously defined array and the number of items in this array. The first argument to `load_module_shlib` is the name identifying the module, which is also used to format the corresponding library name, as described [here](loader/rtusage#shared-library-names) + +After a successful `load__module_shlib` call, the function pointer of each `loader_shlibfunc_t` array item has been set and can be used to call the corresponding function. + +Typical loader usage looks like: + +```c +/* shared library loader include file */ +#include "common/utils/load_module_shlib.h" +............. +/* + define and initialize the array, describing the list of functions + implemented in "mymodule" +*/ + loader_shlibfunc_t mymodule_fdesc[2]; + mymodule_fdesc[0].fname="mymodule_f1"; + mymodule_fdesc[1].fname="mymodule_f2"; + +/* + load the library, it's name must be libmymod.so. Configuration can be + used to specify a specific path to look for libmymod.so. Configuration + can also specify a version, for example "V1", in this case the loader + will look for libmymodV1.so +*/ + ret=load_module_shlib("mymod",mymodule_fdesc, sizeof(mymodule_fdesc)/sizeof(loader_shlibfunc_t)); + if (ret < 0) { + fprintf(stderr,"Library couldn't be loaded\n"); + } else { +/* +library has been loaded, we probably want to call some functions... +*/ + ret=((funcf1_t)mymodule_fdesc[0].fptr)(); + +.................. +/* +later and/or somewhere else in the code you may want to call function "mymodule_f2" +You can use the loader get_shlibmodule_fptr(char *modname, char *fname) function +to retrieve the pointer to that function +*/ +funcf2_t *f2; +int ret; +int intarg1; +char *strarg; +........................ +f2 = (funcf2_t)get_shlibmodule_fptr("mymodule", "mymodule_f2") +if (f2 != NULL) { + ret = f2(intarg1,strarg); +} +............... +``` +When loading a shared library the loader looks for a symbol named `< module name > _autoinit` and, if it finds it, calls it. The `autoinit` function is called without any argument and the returned value, if any, is not tested. + +[loader home page](loader) +[loader developer home page](loader/devusage) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/struct.md b/common/utils/DOC/loader/devusage/struct.md new file mode 100644 index 0000000000..b771f136d7 --- /dev/null +++ b/common/utils/DOC/loader/devusage/struct.md @@ -0,0 +1,10 @@ +# `loader_shlibfunc_t`structure +It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/load_module_shlib.h#L38). This structure is used to list the symbols that should be searched by the loader when calling the `load_module_shlib` function. + +| Fields | Description | I/O | +|:-----------|:------------------------------------------------------------------|----:| +| `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I | +| `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O | + +[loader home page](loader) +[loader developer home page](loader/devusage) \ No newline at end of file diff --git a/common/utils/DOC/loader/rtusage.md b/common/utils/DOC/loader/rtusage.md new file mode 100644 index 0000000000..cdd2883153 --- /dev/null +++ b/common/utils/DOC/loader/rtusage.md @@ -0,0 +1,50 @@ +## shared library names +Shared library full names are built by the loader using the format: +> < *path* >/lib< *module name* >< *module version* >.so + +1. the < *module name* > is defined at development time, it comes from the `modname` argument of the `load_module_shlib` call. +1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration. + +## loader parameters +The loader is using the [configuration module](config), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. +### Global loader parameters +| name | type | default | description | +|:---:|:---:|:---:|:----| +| `shlibpath` | `string of char` | `""` | directory path used to look for shared libraries, may be superseded by the library specific `shlibpath`.| +| `maxshlibs` | `integer` | 10 | Maximum number of shared libraries the loader can manage. | + +### library specific loader parameters +| name | type | default | description | +|:---:|:---:|:---:|:----| +| `shlibpath` | `string of char` | `""` | directory path used to look for this shared library.| +| `shlibversion` | `string of char` | `""` | version to be used to load this shared library.| + +### loader configuration examples + +The following configuration file example just reproduce the default loader parameters: +```c +loader : +{ + shlibpath = "./"; + maxshlibs = 10; + liboai_device : + { + shlibpath = "./"; + shlibversion = ""; + } +}; +``` +If you want to load a device called *liboai_device_USRP.so* without writting a specific configuration, you can start the softmodem using the following command: +> ./lte-softmodem -O libconfig:/usr/local/oai/openairinterface5g/targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.nbiot.band7.tm1.50PRB.usrpb210.conf:dbgl5 --loader.oai_device.shlibversion _USRP + +With this latest example, nn the softmodem logs, you can check that the right device library has been loaded: +```bash +[LIBCONFIG] loader.oai_device.shlibpath not found in /usr/local/oai/develop-nb-iot-merge/openairinterface5g/targets/PROJECTS/GENERIC-LTE-EPC/CONF/enb.nbiot.band7.tm1.50PRB.usrpb210.conf +[LIBCONFIG] loader.oai_device.shlibversion set to default value "" +[LIBCONFIG] loader.oai_device: 1/2 parameters successfully set, (1 to default value) +[CONFIG] shlibversion set to _USRP from command line +[CONFIG] loader.oai_device 1 options set from command line + +``` + +[loader home page](loader) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetaddcmd.md b/common/utils/telnetsrv/DOC/telnetaddcmd.md new file mode 100644 index 0000000000..9d23b6917f --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetaddcmd.md @@ -0,0 +1,116 @@ +# code example of adding a command to the telnet server + +The following example is extracted from [the oai `openair1/PHY/CODING/coding_load.c` file](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c). + +```c +/* +include the telnet server data structures and API definitions +*/ +#include "common/utils/telnetsrv/telnetsrv.h" + + +/* +define the null terminated array of telnetshell_cmddef_t structures +which map each sub-command string to a function implementing it. +you may also provide a help string which will be printed when +the global help command is used. The prototype for the function +implementing sub commands must match the `cmdfunc_t` type defined +in `telnetsrv.h` +*/ +static int coding_setmod_cmd(char *buff, int debug, telnet_printfunc_t prnt); +static telnetshell_cmddef_t coding_cmdarray[] = { + {"mode","[sse,avx2,stdc,none]",coding_setmod_cmd}, + {"","",NULL}, +}; + +/* +define the null terminated list of telnetshell_vardef_t structures defining the +variables that can be set and get using the pre-defined get and set command +of the telnet server +*/ +telnetshell_vardef_t coding_vardef[] = { +{"maxiter",TELNET_VARTYPE_INT32,&max_turbo_iterations}, +{"",0,NULL} +}; +................. +/* + look for telnet server, if it is loaded, add the coding commands to it + we use the shared library loader API to check the telnet server availibility +The telnet server TELNET_ADDCMD_FNAME function takes three arguments: +1. The name of the telnet command to be added, here "coding" +1. The `coding_cmdarray` list of "coding" sub-commands we defined earlier +1. The `coding_varde f`list of variables we defined earlier +*/ + add_telnetcmd_func_t addcmd = (add_telnetcmd_func_t)get_shlibmodule_fptr("telnetsrv", TELNET_ADDCMD_FNAME); + if (addcmd != NULL) { + addcmd("coding",coding_vardef,coding_cmdarray); +....... +/* + functions implementing the "coding mode" sub command, as defined in + the `coding_cmdarray` passed earlier to the TELNET_ADDCMD_FNAME function. + This function will be called by the telnet server, when the `coding_cmdarray` + command is received from the telnet client +*/ +int coding_setmod_cmd(char *buff, int debug, telnet_printfunc_t prnt) +{ + /* + 1. buff argument is an input argument, pointer to the string received + from the telnet client, the command and sub-command parts are removed + In this case it points after "coding setmod" and is of no use as + we don't have second level sub-commands. + 1. debug argument is an input argument set by the telnet server + 1. prnt arguments is also an input argument, a function pointer, to be used + in place of printf to print messages on the telnet client interface. As this function + is called by the telnet server stdout points to the main executable console, + */ + if (debug > 0) + prnt( "coding_setmod_cmd received %s\n",buff); + + if (strcasestr(buff,"sse") != NULL) { + decoding_setmode(MODE_DECODE_SSE); + } else if (strcasestr(buff,"avx2") != NULL) { + decoding_setmode(MODE_DECODE_AVX2); + } else if (strcasestr(buff,"stdc") != NULL) { + decoding_setmode(MODE_DECODE_C); + } else if (strcasestr(buff,"none") != NULL) { + decoding_setmode(MODE_DECODE_NONE); + } else { + prnt("%s: wrong setmod parameter...\n",buff); + } + prnt("Coding and decoding current mode: %s\n",modedesc[curmode]); + return 0; +} + +.............. + +``` +# telnet server API + +```c +int add_telnetcmd(char *modulename, telnetshell_vardef_t *var, telnetshell_cmddef_t *cmd) +``` +Add a command and the `cmd` list of sub-commands to the telnet server. After a successful call to `add_telnetcmd` function, the telnet server calls the function defined for each sub-commands in the null terminated `cmd` array, when the character string received from the telnet client matches the command and sub-command strings. +Also adds the list of variables described in the `var` array to the list of variable which can be set and read. +The function returns -1 if one argument is NULL. +The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd#code-example-of-adding-a-command-to-the-telnet-server). + +# telnet server public data types +## `telnetshell_vardef_t`structure + This structure is used by developers to describe the variables that can be set or read using the get,set and getall sub-commands. + +| Fields | type |Description | +|:-----------|:------:|:-----------------------| +| `varname` | `char[TELNET_CMD_MAXSIZE]` | variable name, as specified when using the get and set commands. | +| `vartype` | `char` | Defines the type of the variable pointed by the `varvalptr`field. Supported values: TELNET_VARTYPE_INT32 TELNET_VARTYPE_INT16 TELNET_VARTYPE_INT64 TELNET_VARTYPE_STRING TELNET_VARTYPE_DOUBLE | +| `varvalptr` | `void*` | Defines the type of the variable pointed by the `varvalptr`field | + +## `telnetshell_cmddef_t`structure + This structure is used by developers to describe the first level sub-commands to be added to the telnet server. + +| Fields | type |Description | +|:-----------|:------:|:-----------------------| +| `cmdname` | `char[TELNET_CMD_MAXSIZE]` | command name, as tested by the telnet server to check it should call the `cmdfunc` function | +| `helpstr` | `char[TELNET_HELPSTR_SIZE]` | character string to print when the elp`command is received from the telnet client | +| `cmdfunc` | `cmdfunc_t` | pointer to the function implementing the `cmdname` sub command. | + +[oai telnet server home](telnetsrv) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetarch.md b/common/utils/telnetsrv/DOC/telnetarch.md new file mode 100644 index 0000000000..579a7de967 --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetarch.md @@ -0,0 +1,21 @@ +# telnet server principles + +The oai telnet server is implemented in a shared library to be loaded by the [oai shared library loader](loader). The implementation includes a `telnetsrv_autoinit` function which is automatically called at load time, starts the telnet server and registers a first set of commands, which are delivered with the server (telnet, softmodem, loader). + +Currently the telnet server only supports one user connection. The same dedicated thread is used to wait for a user connection and process the input received from this connection. + +The telnet server provides an API which can be used by any oai component to add new CLI commands to the server. A pre-defined command can be used to get or set a list of variables. + + + +# telnet server source files + +telnet server source files are located in [common/utils/telnetsrv](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/telnetsrv) + +1. [telnetsrv.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/telnetsrv/telnetsrv.c) contains the telnet server implementation, including the implementation of the telnet CLI command. +1. [telnetsrv.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/telnetsrv/telnetsrv.h) is the telnet server include file containing both private and public data type definitions. It also contains API prototypes for functions that are used to register a new command in the server. +1. `telnetsrv\_\.c`: implementation of \ CLI command which are delivered with the telnet server. +1. `telnetsrv\_\.h`: include file for the implementation of XXX CLI command. Usually included only in the corresponding `.c`file +1. [telnetsrv_CMakeLists.txt](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv_CMakeLists.txt): CMakelists file containing the cmake instructions to build the telnet server. this file is included in the [global oai CMakelists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt). + +[oai telnet server home](telnetsrv) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetgetset.md b/common/utils/telnetsrv/DOC/telnetgetset.md new file mode 100644 index 0000000000..ccf774a752 --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetgetset.md @@ -0,0 +1,21 @@ +getall command can be used to get the list of variables that can bet set or get from the telnet shell. Knowing the names of the variables they can then be set or read. Setting a variable is not always relevant, the telnet server doesn't provide a mechanism to restrict the set command. + +```bash +softmodem> telnet getall +telnet, debug = 0 +telnet, prio = 0 +telnet, loopc = 10 +telnet, loopd = 5000 +telnet, phypb = 65000 +telnet, hsize = 50 +telnet, hfile = "oaitelnet.history" +softmodem> telnet set loopc 100 +telnet, loopc set to +100 +softmodem> telnet get loopc +telnet, loopc = 100 +softmodem> + +``` +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethelp.md b/common/utils/telnetsrv/DOC/telnethelp.md new file mode 100644 index 0000000000..ef614cae1c --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnethelp.md @@ -0,0 +1,57 @@ +# oai telnet server global help + +``` bash +alblf@at8020-a:~$ telnet 10.133.10.77 9090 +Trying 10.133.10.77... +Connected to 10.133.10.77. +Escape character is '^]'. + +softmodem> help + module 0 = telnet: + telnet [get set] debug + telnet [get set] prio + telnet [get set] loopc + telnet [get set] loopd + telnet [get set] phypb + telnet [get set] hsize + telnet [get set] hfile + telnet redirlog [here,file,off] + telnet param [prio] + telnet history [list,reset] + module 1 = softmodem: + softmodem show loglvl|thread|config + softmodem log (enter help for details) + softmodem thread (enter help for details) + softmodem exit + module 2 = phy: + phy disp [phycnt,uedump,uestat UE] + module 3 = loader: + loader [get set] mainversion + loader [get set] defpath + loader [get set] maxshlibs + loader [get set] numshlibs + loader show [params,modules] + module 4 = coding: + coding [get set] maxiter + coding mode [sse,avx2,stdc,none] +softmodem> +``` + +# oai telnet server, specific commands help + +``` bash +softmodem> softmodem log help + log sub commands: + show: display current log configuration + online, noonline: enable or disable console logs + enable, disable id1-id2: enable or disable logs for components index id1 to id2 + level_ id1-id2: set log level to for components index id1 to id2 + level_ id1-id2: set log verbosity to for components index id1 to id2 +use the show command to get the values for , and the list of component indexes that can be used for id1 and id2 +softmodem> + + +``` + +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethist.md b/common/utils/telnetsrv/DOC/telnethist.md new file mode 100644 index 0000000000..10682b8a85 --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnethist.md @@ -0,0 +1,44 @@ +The telnet server implements a simple history system +```bash +softmodem> telnet history list +1: telnet history list +2: telnet history list +3: help +4: loader show modules +5: softmodem show loglvl +6: help +7: telnet history +8: help +9: telnet history list +10: help +11: loader show modules +12: softmodem show loglvl +13: softmodem log help +14: softmodem log disable 0-35 +15: softmodem log show +16: help +17: telnet history list +18: loader show modules +19: softmodem thread show +20: help +21: softmodem thread help +22: softmodem log show +23: softmodem log help +24: softmodem log level_error 0-4 +25: loader show modules +26: loader show config +27: help +28: loader show params +29: loader show modules +softmodem> !28 +softmodem> loader show params +loader parameters: + Main executable build version: "Branch: develop-telnet-loader-fixes Abrev. Hash: e56ae69 Date: Fri Mar 9 16:47:08 2018 +0100" + Default shared lib path: "" + Max number of shared lib : 10 +softmodem> + +``` + +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloader.md b/common/utils/telnetsrv/DOC/telnetloader.md new file mode 100644 index 0000000000..d64f0c6cdb --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetloader.md @@ -0,0 +1,47 @@ +loader command can be used to check loader configuration parameters and the list of loaded shared libraries and for each library the list of available functions. + +```bash +softmodem> loader show params +loader parameters: + Main executable build version: "Branch: develop-telnet-loader-fixes Abrev. Hash: e56ae69 Date: Fri Mar 9 16:47:08 2018 +0100" + Default shared lib path: "" + Max number of shared lib : 10 +softmodem> loader show modules +4 shared lib have been dynamicaly loaded by the oai loader + Module 0: telnetsrv + Shared library build version: "Branch: develop-telnet-loader-fixes Abrev. Hash: e56ae69 Date: Fri Mar 9 16:47:08 2018 +0100" + Shared library path: "libtelnetsrv.so" + 1 function pointers registered: + function 0 add_telnetcmd at 0x7ff8b772a2b0 + Module 1: NB_IoT + Shared library build version: "" + Shared library path: "libNB_IoT.so" + 1 function pointers registered: + function 0 RCConfig_NbIoT at 0x7ff8b6b1b390 + Module 2: coding + Shared library build version: "Branch: develop-telnet-loader-fixes Abrev. Hash: e56ae69 Date: Fri Mar 9 16:47:08 2018 +0100" + Shared library path: "libcoding.so" + 13 function pointers registered: + function 0 init_td8 at 0x7ff8adde63a0 + function 1 init_td16 at 0x7ff8adde9760 + function 2 init_td16avx2 at 0x7ff8addec050 + function 3 phy_threegpplte_turbo_decoder8 at 0x7ff8adde6780 + function 4 phy_threegpplte_turbo_decoder16 at 0x7ff8adde9a90 + function 5 phy_threegpplte_turbo_decoder_scalar at 0x7ff8addef4a0 + function 6 phy_threegpplte_turbo_decoder16avx2 at 0x7ff8addec530 + function 7 free_td8 at 0x7ff8adde61d0 + function 8 free_td16 at 0x7ff8adde9590 + function 9 free_td16avx2 at 0x7ff8addebe80 + function 10 threegpplte_turbo_encoder_sse at 0x7ff8adde45b0 + function 11 threegpplte_turbo_encoder at 0x7ff8adde4a30 + function 12 init_encoder_sse at 0x7ff8adde49d0 + Module 3: oai_device + Shared library build version: "" + Shared library path: "liboai_device_usrp.so" + 1 function pointers registered: + function 0 device_init at 0x7ff8ac16a7a0 +softmodem> +``` + +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetlog.md b/common/utils/telnetsrv/DOC/telnetlog.md new file mode 100644 index 0000000000..00f09a3a6f --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetlog.md @@ -0,0 +1,95 @@ +The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp#oai-telnet-server-specific-commands-help) +```bash +softmodem> softmodem log disable 0-35 +log level/verbosity comp 0 PHY set to info / medium (disabled) +log level/verbosity comp 1 MAC set to info / medium (disabled) +log level/verbosity comp 2 EMU set to info / medium (disabled) +log level/verbosity comp 3 OCG set to info / medium (disabled) +log level/verbosity comp 4 OMG set to info / medium (disabled) +log level/verbosity comp 5 OPT set to info / medium (disabled) +log level/verbosity comp 6 OTG set to info / medium (disabled) +log level/verbosity comp 7 OTG_LATENCY set to info / medium (disabled) +log level/verbosity comp 8 OTG_LATENCY_BG set to info / medium (disabled) +log level/verbosity comp 9 OTG_GP set to info / medium (disabled) +log level/verbosity comp 10 OTG_GP_BG set to info / medium (disabled) +log level/verbosity comp 11 OTG_JITTER set to info / medium (disabled) +log level/verbosity comp 12 RLC set to info / medium (disabled) +log level/verbosity comp 13 PDCP set to info / medium (disabled) +log level/verbosity comp 14 RRC set to info / medium (disabled) +log level/verbosity comp 15 NAS set to info / medium (disabled) +log level/verbosity comp 16 PERF set to info / medium (disabled) +log level/verbosity comp 17 OIP set to info / medium (disabled) +log level/verbosity comp 18 CLI set to info / medium (disabled) +log level/verbosity comp 19 MSC set to info / medium (disabled) +log level/verbosity comp 20 OCM set to info / medium (disabled) +log level/verbosity comp 21 UDP set to info / medium (disabled) +log level/verbosity comp 22 GTPV1U set to info / medium (disabled) +log level/verbosity comp 23 comp23? set to info / medium (disabled) +log level/verbosity comp 24 S1AP set to info / medium (disabled) +log level/verbosity comp 25 SCTP set to info / medium (disabled) +log level/verbosity comp 26 HW set to info / medium (disabled) +log level/verbosity comp 27 OSA set to info / medium (disabled) +log level/verbosity comp 28 eRAL set to info / medium (disabled) +log level/verbosity comp 29 mRAL set to info / medium (disabled) +log level/verbosity comp 30 ENB_APP set to info / medium (disabled) +log level/verbosity comp 31 FLEXRAN_AGENT set to info / medium (disabled) +log level/verbosity comp 32 TMR set to info / medium (disabled) +log level/verbosity comp 33 USIM set to info / medium (disabled) +log level/verbosity comp 34 LOCALIZE set to info / medium (disabled) +log level/verbosity comp 35 RRH set to info / medium (disabled) +softmodem> softmodem log show +Available log levels: + emerg alert crit error warn notice info debug file trace +Available verbosity: + none low medium high full +component verbosity level enabled +00 PHY: medium info N +01 MAC: medium info N +02 EMU: medium info N +03 OCG: medium info N +04 OMG: medium info N +05 OPT: medium info N +06 OTG: medium info N +07 OTG_LATENCY: medium info N +08 OTG_LATENCY_BG: medium info N +09 OTG_GP: medium info N +10 OTG_GP_BG: medium info N +11 OTG_JITTER: medium info N +12 RLC: medium info N +13 PDCP: medium info N +14 RRC: medium info N +15 NAS: medium info N +16 PERF: medium info N +17 OIP: medium info N +18 CLI: medium info N +19 MSC: medium info N +20 OCM: medium info N +21 UDP: medium info N +22 GTPV1U: medium info N +23 comp23?: medium info N +24 S1AP: medium info N +25 SCTP: medium info N +26 HW: medium info N +27 OSA: medium info N +28 eRAL: medium info N +29 mRAL: medium info N +30 ENB_APP: medium info N +31 FLEXRAN_AGENT: medium info N +32 TMR: medium info N +33 USIM: medium info N +34 LOCALIZE: medium info N +35 RRH: medium info N +36 comp36?: medium info Y +37 LOADER: medium alert Y +softmodem> softmodem log level_error 0-4 +log level/verbosity comp 0 PHY set to error / medium (enabled) +log level/verbosity comp 1 MAC set to error / medium (enabled) +log level/verbosity comp 2 EMU set to error / medium (enabled) +log level/verbosity comp 3 OCG set to error / medium (enabled) +log level/verbosity comp 4 OMG set to error / medium (enabled) +softmodem> exit +Connection closed by foreign host. +``` + +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloop.md b/common/utils/telnetsrv/DOC/telnetloop.md new file mode 100644 index 0000000000..437481da68 --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetloop.md @@ -0,0 +1,40 @@ +The telnet server includes a **_loop_** command that can be used to iterate a given command. The number of iterations and the delay, in ms between two iterations can be modified, as shown in the following example: + +```bash +softmodem> telnet get loopc +telnet, loopc = 10 +softmodem> telnet get loopd +telnet, loopd = 2000 +softmodem> telnet set loopd 1000 +telnet, loopd set to +1000 +softmodem> loop softmodem show thread + 2018-03-27 17:58:49.000 2/10 + id name state USRmod KRNmod prio nice vsize proc pol + + 3946 lte-softmodem S 20005 9440 20 0 236560384 2 0 other + + 3946 lte-softmodem S 7 95 20 0 236560384 2 0 other + 3948 telnet R 0 0 20 0 236560384 2 0 other + 3949 ITTI acceptor S 2 9 20 0 236560384 2 0 other + 3951 ITTI 12 S 2 2 20 0 236560384 7 0 other + 3952 ITTI 11 S 0 0 20 0 236560384 0 0 other + 3953 ITTI 9 S 0 0 20 0 236560384 1 0 other + 3954 ITTI 7 S 0 0 20 0 236560384 7 0 other + 3955 ITTI 8 S 0 0 20 0 236560384 7 0 other + 3956 ITTI 4 S 35 0 20 0 236560384 2 0 other + 3957 ru_thread S 15366 3072 -10 0 236560384 0 2 rt: rr + 3958 ru_thread_prach S 0 0 -10 0 236560384 7 1 rt: fifo + 3959 fep_thread S 1874 123 -10 0 236560384 5 1 rt: fifo + 3960 feptx_thread S 1554 101 -10 0 236560384 7 1 rt: fifo + 3969 ru_thread S 0 0 -10 0 236560384 0 2 rt: rr + 3970 ru_thread S 1313 5522 -10 0 236560384 5 2 rt: rr + 3971 ru_thread S 4 6 -10 0 236560384 1 2 rt: rr + 3972 lte-softmodem S 318 9 -10 0 236560384 7 1 rt: fifo + 3973 lte-softmodem S 6 13 -10 0 236560384 4 1 rt: fifo + +``` +A **_loop_** command can be interrupted by pressing the **_enter_** key till getting the prompt. + +[oai telnetserver home](telnetsrv) +[oai telnetserver usage home](telnetusage) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetsrv.md b/common/utils/telnetsrv/DOC/telnetsrv.md new file mode 100644 index 0000000000..c621e7f6e5 --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetsrv.md @@ -0,0 +1,7 @@ +The oai embedded telnet server is an optional monitoring and debugging tool. It provides a simple Command Line Interface to the oai softmem. New commands can easily be added by developers to the telnet server. + +* [Using the telnet server](telnetusage) +* [Adding commands to the oai telnet server](telnetaddcmd) +* [telnet server architecture ](telnetarch) + +[oai Wikis home](home) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetusage.md b/common/utils/telnetsrv/DOC/telnetusage.md new file mode 100644 index 0000000000..2b5aaf405f --- /dev/null +++ b/common/utils/telnetsrv/DOC/telnetusage.md @@ -0,0 +1,39 @@ +# starting the softmodem with the telnet server +By default the embedded telnet server, which is implemented in a shared library, is not built. It can be built after compiling the softmodem executable using the `build_oai` script: + +```bash + cd \/openairinterface5g + source oaienv + cd cmake_targets + ./build_oai --build-telnetsrv +``` + +This will create the `libtelnetsrv.so` file in the `targets/bin` and `cmake_targets/lte_build_oai/build` sub directories of the oai repository. + +When starting the softmodem, you must specify the **_\-\-telnetsrv_** option to load and start the telnet server. The telnet server is loaded via the [oai shared library loader](loader). + +# using the Command Line Interface +By default the telnet server listen on all the ip addresses configured on the system and on port 9090. This behavior can be changed using the `listenaddr` and `listenport` parameters. +The telnet server includes a basic help, listing available commands and some commands also provide a specific detailed help sub-command. +Below are examples of telnet sessions: + +* [getting help](telnethelp) +* [using the history](telnethist) +* [using the get and set commands](telnetgetset) +* [using the loop command](telnetloop) +* [loader command](telnetloader) +* [log command](telnetlog) + +# telnet server parameters +The telnet server is using the [oai configuration module](Config/Rtusage). Telnet parameters must be specified in the `telnetsrv` section. Some parameters can be modified via the telnet telnet server command, as specified in the last column of the following table. + +| name | type | default | description | dynamic | +|:---:|:---:|:---:|:----|:----:| +| `listenaddr` | `ipV4 address, ascii format` | "0.0.0.0" | local address the server is listening on| N | +| `listenport` | `integer` | 9090 | port number the server is listening on | N | +| `loopcount` | `integer` | 10 | number of iterations for the loop command | Y | +| `loopdelay` | `integer` | 5000 | delay (in ms) between 2 loop command iterations | Y | +| `histfile` | `character string` | "oaitelnet.history" | file used for command history persistency | Y | +| `histfsize` | `integer` | 50 | maximum number of commands saved in the history | Y | + +[oai telnet server home](telnetsrv) \ No newline at end of file From c570ad63fe61e563d0d75735a820ebdd40600ff4 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:21:33 +0100 Subject: [PATCH 04/25] fix config DOC broken links --- common/config/DOC/config.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/common/config/DOC/config.md b/common/config/DOC/config.md index 682780cd3b..580ac5476f 100644 --- a/common/config/DOC/config.md +++ b/common/config/DOC/config.md @@ -4,8 +4,8 @@ The configuration module provides an api that other oai components can use to ge ## Documentation -* [runtime usage](config/rtusage) -* [developer usage](config/devusage) -* [module architecture](config/arch) +* [runtime usage](config/rtusage.md) +* [developer usage](config/devusage.md) +* [module architecture](config/arch.md) [oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home) From 7df76dfbfc31c2cdc420a9b4808a3fb0f8a3b988 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:24:01 +0100 Subject: [PATCH 05/25] fix config doc broken link --- common/config/DOC/config/rtusage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/config/DOC/config/rtusage.md b/common/config/DOC/config/rtusage.md index 828f6a959d..ba362d011e 100644 --- a/common/config/DOC/config/rtusage.md +++ b/common/config/DOC/config/rtusage.md @@ -49,4 +49,4 @@ $ ./lte-softmodem -O --eNBs.[0].component_carriers.[0].N_RB_DL 100 As specified earlier, use the dbgl1 debug level to get the full name of a parameter you would like to modify on the command line. -[Configuration module home](config) \ No newline at end of file +[Configuration module home](../config) \ No newline at end of file From 736febd06470a20f31aacfcc584ec6109b494fca Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:26:24 +0100 Subject: [PATCH 06/25] fix broken link --- common/config/DOC/config/rtusage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/config/DOC/config/rtusage.md b/common/config/DOC/config/rtusage.md index ba362d011e..19519ef058 100644 --- a/common/config/DOC/config/rtusage.md +++ b/common/config/DOC/config/rtusage.md @@ -49,4 +49,4 @@ $ ./lte-softmodem -O --eNBs.[0].component_carriers.[0].N_RB_DL 100 As specified earlier, use the dbgl1 debug level to get the full name of a parameter you would like to modify on the command line. -[Configuration module home](../config) \ No newline at end of file +[Configuration module home](../config.md) \ No newline at end of file From 65fd02b1b6ac3a7f93c2da56e8ce10846f091284 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:29:37 +0100 Subject: [PATCH 07/25] fix config doc broken links --- common/config/DOC/config/devusage.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/common/config/DOC/config/devusage.md b/common/config/DOC/config/devusage.md index 88abc96f42..9e4c7013e7 100644 --- a/common/config/DOC/config/devusage.md +++ b/common/config/DOC/config/devusage.md @@ -5,10 +5,10 @@ The configuration module objectives are As a developer you may need to look at these sections: -* [add parameters in an existing section](config/devusage/addaparam) -* [add a parameter set, in a new section](config/devusage/addparamset) -* [configuration module API](config/devusage/api) -* [configuration module public structures](config/devusage/struct) +* [add parameters in an existing section](devusage/addaparam) +* [add a parameter set, in a new section](devusage/addparamset) +* [configuration module API](devusage/api) +* [configuration module public structures](devusage/struct) Whatever your need is, configuration module usage examples can be found in oai sources: * complex example, using all the configuration module functionalities, including parameter checking: @@ -17,4 +17,4 @@ Whatever your need is, configuration module usage examples can be found in oai s * an example with run-time definition of parameters, in the logging sub-system: the log_getconfig function at the top of [openair2/UTIL/LOG/log.c](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair2/UTIL/LOG/log.c) -[Configuration module home](config) +[Configuration module home](../config.md) From ef2088166422845077107a18df5d0ff331a02035 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:32:32 +0100 Subject: [PATCH 08/25] fix config doc broken links --- common/config/DOC/config/devusage.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/common/config/DOC/config/devusage.md b/common/config/DOC/config/devusage.md index 9e4c7013e7..bfc1180ab8 100644 --- a/common/config/DOC/config/devusage.md +++ b/common/config/DOC/config/devusage.md @@ -5,10 +5,10 @@ The configuration module objectives are As a developer you may need to look at these sections: -* [add parameters in an existing section](devusage/addaparam) -* [add a parameter set, in a new section](devusage/addparamset) -* [configuration module API](devusage/api) -* [configuration module public structures](devusage/struct) +* [add parameters in an existing section](devusage/addaparam.md) +* [add a parameter set, in a new section](devusage/addparamset.md) +* [configuration module API](devusage/api.md) +* [configuration module public structures](devusage/struct.md) Whatever your need is, configuration module usage examples can be found in oai sources: * complex example, using all the configuration module functionalities, including parameter checking: From a149d1cbfd9e0451c6cf7886cb76e342c3de25d4 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:34:07 +0100 Subject: [PATCH 09/25] fix broken links in api.md --- common/config/DOC/config/devusage/api.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common/config/DOC/config/devusage/api.md b/common/config/DOC/config/devusage/api.md index c9d562ced0..56b444a447 100644 --- a/common/config/DOC/config/devusage/api.md +++ b/common/config/DOC/config/devusage/api.md @@ -44,5 +44,5 @@ int config_libconfig_getlist(paramlist_def_t *ParamList, paramdef_t *params, int * The returned value is the number of occurrences in the list or -1 in case of severe error -[Configuration module developer main page](config/devusage) -[Configuration module home](config) +[Configuration module developer main page](../../config/devusage.md) +[Configuration module home](../../config.md) From a9de514b7cbff03b2531023ea5fbaad93f162d23 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:36:06 +0100 Subject: [PATCH 10/25] fix broken links in addaparam.md --- common/config/DOC/config/devusage/addaparam.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common/config/DOC/config/devusage/addaparam.md b/common/config/DOC/config/devusage/addaparam.md index 28bd3ee142..b7bb8a73b9 100644 --- a/common/config/DOC/config/devusage/addaparam.md +++ b/common/config/DOC/config/devusage/addaparam.md @@ -82,5 +82,5 @@ for(int i=0 ; i < sizeof(someoptions)/sizeof(paramdesc_t) ; i ++) { ``` When you need a specific verification algorithm, you can provide your own verification function and use it in place of the available ones, in the `checkedparam_t` union. If no existing structure definition match your need, you can enhance the configuration module. You then have to add a new verification function in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_userapi.c and add a new structure definition in the `checkedparam_t` type defined in https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/config/config_paramdesc.h -[Configuration module developer main page](config/devusage) -[Configuration module home](config) +[Configuration module developer main page](../../config/devusage.md) +[Configuration module home](../../config.md) From 59a690bb4b97082da233cb88a26412282827a98e Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:38:38 +0100 Subject: [PATCH 11/25] fix broken link in addparamset.md --- common/config/DOC/config/devusage/addparamset.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/common/config/DOC/config/devusage/addparamset.md b/common/config/DOC/config/devusage/addparamset.md index 9b90fcc81f..130e7c690e 100644 --- a/common/config/DOC/config/devusage/addparamset.md +++ b/common/config/DOC/config/devusage/addparamset.md @@ -4,7 +4,7 @@ Retrieving a single occurence of a parameter set ( a group in the libconfig term 1. call the `config_get` function -[config_get example](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/config/devusage/addaparam) +[config_get example](../../config/devusage/addaparam.md) In oai some parameters set may be instantiated a variable number of occurrences. In a configuration file this is mapped to lists of group of parameters, with this syntax: @@ -127,5 +127,5 @@ list to be read is under another section. ``` -[Configuration module developer main page](config/devusage) -[Configuration module home](config) +[Configuration module developer main page](../../config/devusage.md) +[Configuration module home](../..config.md) From d4092a32f980a5429c5844231d5e15e3c1f5d088 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:40:17 +0100 Subject: [PATCH 12/25] fix typo.... --- common/config/DOC/config/devusage/addparamset.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/config/DOC/config/devusage/addparamset.md b/common/config/DOC/config/devusage/addparamset.md index 130e7c690e..130a7eda74 100644 --- a/common/config/DOC/config/devusage/addparamset.md +++ b/common/config/DOC/config/devusage/addparamset.md @@ -128,4 +128,4 @@ list to be read is under another section. ``` [Configuration module developer main page](../../config/devusage.md) -[Configuration module home](../..config.md) +[Configuration module home](../../config.md) From 95dc47cc0775c124375fe2fc8b58e4deab274e27 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:41:36 +0100 Subject: [PATCH 13/25] fix broken link in struct.md --- common/config/DOC/config/devusage/struct.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/common/config/DOC/config/devusage/struct.md b/common/config/DOC/config/devusage/struct.md index 17a9c36455..236c1b4e03 100644 --- a/common/config/DOC/config/devusage/struct.md +++ b/common/config/DOC/config/devusage/struct.md @@ -81,5 +81,5 @@ The configuration module provides an implementation of the functions to be used |:-----------|:------------------------------------------------------------------| | `f4` or `f5` | pointer to the checking function. they are generic structures to be used when no existing structure provides the required parameter verification. `f4` takes one argument, the `paramdef_t` structure corresponding to the parameter to be checked (`int (*f4)(paramdef_t *param)`), `f5` taxes no argument (`void (*checkfunc)(void)`) | -[Configuration module developer main page](config/devusage) -[Configuration module home](config) +[Configuration module developer main page](../../config/devusage.md) +[Configuration module home](../../config.md) From 337c068d220846ad2abbfa8b02e260fa2e9d4fec Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:49:41 +0100 Subject: [PATCH 14/25] fix broken links in telnetsrv.md --- common/utils/telnetsrv/DOC/telnetsrv.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/common/utils/telnetsrv/DOC/telnetsrv.md b/common/utils/telnetsrv/DOC/telnetsrv.md index c621e7f6e5..ab89da3f85 100644 --- a/common/utils/telnetsrv/DOC/telnetsrv.md +++ b/common/utils/telnetsrv/DOC/telnetsrv.md @@ -1,7 +1,7 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It provides a simple Command Line Interface to the oai softmem. New commands can easily be added by developers to the telnet server. -* [Using the telnet server](telnetusage) -* [Adding commands to the oai telnet server](telnetaddcmd) -* [telnet server architecture ](telnetarch) +* [Using the telnet server](telnetusage.md) +* [Adding commands to the oai telnet server](telnetaddcmd.md) +* [telnet server architecture ](telnetarch.md) [oai Wikis home](home) \ No newline at end of file From f08ef335b4166318aa90ed5b2e49aceedc5b6f7c Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 19:51:27 +0100 Subject: [PATCH 15/25] fix broken links in telnetusage.md --- common/utils/telnetsrv/DOC/telnetusage.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/common/utils/telnetsrv/DOC/telnetusage.md b/common/utils/telnetsrv/DOC/telnetusage.md index 2b5aaf405f..f8319d5ef2 100644 --- a/common/utils/telnetsrv/DOC/telnetusage.md +++ b/common/utils/telnetsrv/DOC/telnetusage.md @@ -17,12 +17,12 @@ By default the telnet server listen on all the ip addresses configured on the sy The telnet server includes a basic help, listing available commands and some commands also provide a specific detailed help sub-command. Below are examples of telnet sessions: -* [getting help](telnethelp) -* [using the history](telnethist) -* [using the get and set commands](telnetgetset) -* [using the loop command](telnetloop) -* [loader command](telnetloader) -* [log command](telnetlog) +* [getting help](telnethelp.md) +* [using the history](telnethist.md) +* [using the get and set commands](telnetgetset.md) +* [using the loop command](telnetloop.md) +* [loader command](telnetloader.md) +* [log command](telnetlog.md) # telnet server parameters The telnet server is using the [oai configuration module](Config/Rtusage). Telnet parameters must be specified in the `telnetsrv` section. Some parameters can be modified via the telnet telnet server command, as specified in the last column of the following table. @@ -36,4 +36,4 @@ The telnet server is using the [oai configuration module](Config/Rtusage). Telne | `histfile` | `character string` | "oaitelnet.history" | file used for command history persistency | Y | | `histfsize` | `integer` | 50 | maximum number of commands saved in the history | Y | -[oai telnet server home](telnetsrv) \ No newline at end of file +[oai telnet server home](telnetsrv.md) \ No newline at end of file From 83dde269141a00c778be8146d111325642525325 Mon Sep 17 00:00:00 2001 From: frtabu Date: Thu, 8 Nov 2018 20:16:14 +0100 Subject: [PATCH 16/25] fix broken links --- common/utils/DOC/loader/arch.md | 2 +- common/utils/DOC/loader/devusage.md | 8 ++++---- common/utils/DOC/loader/devusage/api.md | 4 ++-- common/utils/DOC/loader/devusage/loading.md | 4 ++-- common/utils/DOC/loader/devusage/struct.md | 4 ++-- common/utils/DOC/loader/rtusage.md | 4 ++-- common/utils/telnetsrv/DOC/telnetaddcmd.md | 4 ++-- common/utils/telnetsrv/DOC/telnetarch.md | 2 +- common/utils/telnetsrv/DOC/telnetgetset.md | 4 ++-- common/utils/telnetsrv/DOC/telnethelp.md | 4 ++-- common/utils/telnetsrv/DOC/telnethist.md | 4 ++-- common/utils/telnetsrv/DOC/telnetloader.md | 4 ++-- common/utils/telnetsrv/DOC/telnetlog.md | 6 +++--- common/utils/telnetsrv/DOC/telnetloop.md | 4 ++-- common/utils/telnetsrv/DOC/telnetsrv.md | 2 +- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/common/utils/DOC/loader/arch.md b/common/utils/DOC/loader/arch.md index 53a1cc7ea2..c37aedb4ef 100644 --- a/common/utils/DOC/loader/arch.md +++ b/common/utils/DOC/loader/arch.md @@ -4,4 +4,4 @@ The oai shared library loader is implemented in two source files, located in [co 1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation 1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. -[loader home page](loader) \ No newline at end of file +[loader home page](..loader.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage.md b/common/utils/DOC/loader/devusage.md index 89d15aa75e..4b82e18362 100644 --- a/common/utils/DOC/loader/devusage.md +++ b/common/utils/DOC/loader/devusage.md @@ -5,13 +5,13 @@ The configuration module objectives are As a developer you may need to look at these sections: -* [loading a shared library](loader/devusage/loading) -* [loader API](loader/devusage/api) -* [loader public structures](loader/devusage/struct) +* [loading a shared library](devusage/loading.md) +* [loader API](devusage/api.md) +* [loader public structures](devusage/struct.md) Loader usage examples can be found in oai sources: * device and transport initialization code: [function `load_lib` in *targets/ARCH/COMMON/__common_lib.c__* ](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/targets/ARCH/COMMON/common_lib.c#L91) * turbo encoder and decoder initialization: [function `load_codinglib`in *openair1/PHY/CODING/__coding_load.c__*](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/openair1/PHY/CODING/coding_load.c#L113) -[loader home page](loader) +[loader home page](../loader.md) diff --git a/common/utils/DOC/loader/devusage/api.md b/common/utils/DOC/loader/devusage/api.md index e01d69e9d4..eabfe677e9 100644 --- a/common/utils/DOC/loader/devusage/api.md +++ b/common/utils/DOC/loader/devusage/api.md @@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname) ``` Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../loader.md) +[loader developer home page](../devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/loading.md b/common/utils/DOC/loader/devusage/loading.md index e544830c03..766bf85462 100644 --- a/common/utils/DOC/loader/devusage/loading.md +++ b/common/utils/DOC/loader/devusage/loading.md @@ -52,5 +52,5 @@ if (f2 != NULL) { ``` When loading a shared library the loader looks for a symbol named `< module name > _autoinit` and, if it finds it, calls it. The `autoinit` function is called without any argument and the returned value, if any, is not tested. -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../loader.md) +[loader developer home page](../../loader/devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/devusage/struct.md b/common/utils/DOC/loader/devusage/struct.md index b771f136d7..e3cfc74993 100644 --- a/common/utils/DOC/loader/devusage/struct.md +++ b/common/utils/DOC/loader/devusage/struct.md @@ -6,5 +6,5 @@ It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab | `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I | | `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O | -[loader home page](loader) -[loader developer home page](loader/devusage) \ No newline at end of file +[loader home page](../..loader.md) +[loader developer home page](../devusage.md) \ No newline at end of file diff --git a/common/utils/DOC/loader/rtusage.md b/common/utils/DOC/loader/rtusage.md index cdd2883153..e6b69f5e80 100644 --- a/common/utils/DOC/loader/rtusage.md +++ b/common/utils/DOC/loader/rtusage.md @@ -6,7 +6,7 @@ Shared library full names are built by the loader using the format: 1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration. ## loader parameters -The loader is using the [configuration module](config), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. +The loader is using the [configuration module](../../../config/DOCconfig.md), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. ### Global loader parameters | name | type | default | description | |:---:|:---:|:---:|:----| @@ -47,4 +47,4 @@ With this latest example, nn the softmodem logs, you can check that the right de ``` -[loader home page](loader) \ No newline at end of file +[loader home page](..loader.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetaddcmd.md b/common/utils/telnetsrv/DOC/telnetaddcmd.md index 9d23b6917f..ef5af3fb7e 100644 --- a/common/utils/telnetsrv/DOC/telnetaddcmd.md +++ b/common/utils/telnetsrv/DOC/telnetaddcmd.md @@ -92,7 +92,7 @@ int add_telnetcmd(char *modulename, telnetshell_vardef_t *var, telnetshell_cmdde Add a command and the `cmd` list of sub-commands to the telnet server. After a successful call to `add_telnetcmd` function, the telnet server calls the function defined for each sub-commands in the null terminated `cmd` array, when the character string received from the telnet client matches the command and sub-command strings. Also adds the list of variables described in the `var` array to the list of variable which can be set and read. The function returns -1 if one argument is NULL. -The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd#code-example-of-adding-a-command-to-the-telnet-server). +The telnet server is dynamically loaded, to use the `add_telnetcmd` function, the shared library loader API should be used to check the availability of the telnet server and retrieve it's address, as shown in [the example at the top of this page](telnetaddcmd.md#code-example-of-adding-a-command-to-the-telnet-server). # telnet server public data types ## `telnetshell_vardef_t`structure @@ -113,4 +113,4 @@ The telnet server is dynamically loaded, to use the `add_telnetcmd` function, t | `helpstr` | `char[TELNET_HELPSTR_SIZE]` | character string to print when the elp`command is received from the telnet client | | `cmdfunc` | `cmdfunc_t` | pointer to the function implementing the `cmdname` sub command. | -[oai telnet server home](telnetsrv) \ No newline at end of file +[oai telnet server home](telnetsrv.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetarch.md b/common/utils/telnetsrv/DOC/telnetarch.md index 579a7de967..f31a51b352 100644 --- a/common/utils/telnetsrv/DOC/telnetarch.md +++ b/common/utils/telnetsrv/DOC/telnetarch.md @@ -18,4 +18,4 @@ telnet server source files are located in [common/utils/telnetsrv](https://gitla 1. `telnetsrv\_\.h`: include file for the implementation of XXX CLI command. Usually included only in the corresponding `.c`file 1. [telnetsrv_CMakeLists.txt](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/common/utils/telnetsrv/telnetsrv_CMakeLists.txt): CMakelists file containing the cmake instructions to build the telnet server. this file is included in the [global oai CMakelists](https://gitlab.eurecom.fr/oai/openairinterface5g/blob/develop/cmake_targets/CMakeLists.txt). -[oai telnet server home](telnetsrv) \ No newline at end of file +[oai telnet server home](telnetsrv.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetgetset.md b/common/utils/telnetsrv/DOC/telnetgetset.md index ccf774a752..e0b2c90d79 100644 --- a/common/utils/telnetsrv/DOC/telnetgetset.md +++ b/common/utils/telnetsrv/DOC/telnetgetset.md @@ -17,5 +17,5 @@ telnet, loopc = 100 softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethelp.md b/common/utils/telnetsrv/DOC/telnethelp.md index ef614cae1c..63183fb611 100644 --- a/common/utils/telnetsrv/DOC/telnethelp.md +++ b/common/utils/telnetsrv/DOC/telnethelp.md @@ -53,5 +53,5 @@ softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnethist.md b/common/utils/telnetsrv/DOC/telnethist.md index 10682b8a85..d938435a24 100644 --- a/common/utils/telnetsrv/DOC/telnethist.md +++ b/common/utils/telnetsrv/DOC/telnethist.md @@ -40,5 +40,5 @@ softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloader.md b/common/utils/telnetsrv/DOC/telnetloader.md index d64f0c6cdb..9250524989 100644 --- a/common/utils/telnetsrv/DOC/telnetloader.md +++ b/common/utils/telnetsrv/DOC/telnetloader.md @@ -43,5 +43,5 @@ softmodem> loader show modules softmodem> ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetlog.md b/common/utils/telnetsrv/DOC/telnetlog.md index 00f09a3a6f..7c1d4f0384 100644 --- a/common/utils/telnetsrv/DOC/telnetlog.md +++ b/common/utils/telnetsrv/DOC/telnetlog.md @@ -1,4 +1,4 @@ -The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp#oai-telnet-server-specific-commands-help) +The log command can be used to get the status of the log parameters and to dynamically modify these parameters. The log command has its own [help](telnethelp.md#oai-telnet-server-specific-commands-help) ```bash softmodem> softmodem log disable 0-35 log level/verbosity comp 0 PHY set to info / medium (disabled) @@ -91,5 +91,5 @@ softmodem> exit Connection closed by foreign host. ``` -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetloop.md b/common/utils/telnetsrv/DOC/telnetloop.md index 437481da68..f045e8a716 100644 --- a/common/utils/telnetsrv/DOC/telnetloop.md +++ b/common/utils/telnetsrv/DOC/telnetloop.md @@ -36,5 +36,5 @@ softmodem> loop softmodem show thread ``` A **_loop_** command can be interrupted by pressing the **_enter_** key till getting the prompt. -[oai telnetserver home](telnetsrv) -[oai telnetserver usage home](telnetusage) \ No newline at end of file +[oai telnetserver home](telnetsrv.md) +[oai telnetserver usage home](telnetusage.md) \ No newline at end of file diff --git a/common/utils/telnetsrv/DOC/telnetsrv.md b/common/utils/telnetsrv/DOC/telnetsrv.md index ab89da3f85..e8909595d9 100644 --- a/common/utils/telnetsrv/DOC/telnetsrv.md +++ b/common/utils/telnetsrv/DOC/telnetsrv.md @@ -4,4 +4,4 @@ The oai embedded telnet server is an optional monitoring and debugging tool. It * [Adding commands to the oai telnet server](telnetaddcmd.md) * [telnet server architecture ](telnetarch.md) -[oai Wikis home](home) \ No newline at end of file +[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home) \ No newline at end of file From 6ce4b9ad667e1f3d0b64d5a872740ac5f6c9b6c4 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:18:13 +0100 Subject: [PATCH 17/25] Update arch.md --- common/config/DOC/config/arch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/config/DOC/config/arch.md b/common/config/DOC/config/arch.md index efe4d9eef7..170241500b 100644 --- a/common/config/DOC/config/arch.md +++ b/common/config/DOC/config/arch.md @@ -4,4 +4,4 @@ ![configmodule_components](/uploads/54f8a3953d5ee53717cd9a3b71f85c68/configmodule_components.png) -[Configuration module home](config) \ No newline at end of file +[Configuration module home](../config.md) \ No newline at end of file From 91ba760a029f6d3eaea4a7b87a3a1817fa73dd99 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:21:17 +0100 Subject: [PATCH 18/25] Update loader.md --- common/utils/DOC/loader.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/common/utils/DOC/loader.md b/common/utils/DOC/loader.md index 7ed23952aa..91ff0c02f0 100644 --- a/common/utils/DOC/loader.md +++ b/common/utils/DOC/loader.md @@ -10,8 +10,8 @@ The main drawback is a performance cost at init time, when loading libraries. ## Documentation -* [runtime usage](loader/rtusage) -* [developer usage](loader/devusage) -* [module architecture](loader/arch) +* [runtime usage](loader/rtusage.md) +* [developer usage](loader/devusage.md) +* [module architecture](loader/arch.md) -[oai Wikis home](home) \ No newline at end of file +[oai Wikis home](https://gitlab.eurecom.fr/oai/openairinterface5g/wikis/home) \ No newline at end of file From 894fc6072cb9e663b3a5793fe64f7a39e552af04 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:24:27 +0100 Subject: [PATCH 19/25] Update rtusage.md --- common/utils/DOC/loader/rtusage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/rtusage.md b/common/utils/DOC/loader/rtusage.md index e6b69f5e80..903d249d65 100644 --- a/common/utils/DOC/loader/rtusage.md +++ b/common/utils/DOC/loader/rtusage.md @@ -47,4 +47,4 @@ With this latest example, nn the softmodem logs, you can check that the right de ``` -[loader home page](..loader.md) \ No newline at end of file +[loader home page](../loader.md) \ No newline at end of file From eb6afba80966361170a0e75bf149d0d10e1f0406 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:25:54 +0100 Subject: [PATCH 20/25] Update api.md --- common/utils/DOC/loader/devusage/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/devusage/api.md b/common/utils/DOC/loader/devusage/api.md index eabfe677e9..ffbc9d7d4b 100644 --- a/common/utils/DOC/loader/devusage/api.md +++ b/common/utils/DOC/loader/devusage/api.md @@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname) ``` Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. -[loader home page](../loader.md) +[loader home page](../../../loader.md) [loader developer home page](../devusage.md) \ No newline at end of file From d49d0b10a6b20a1ca96882ba959c5ea11efc709a Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:26:44 +0100 Subject: [PATCH 21/25] Update api.md --- common/utils/DOC/loader/devusage/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/devusage/api.md b/common/utils/DOC/loader/devusage/api.md index ffbc9d7d4b..21c2a1d253 100644 --- a/common/utils/DOC/loader/devusage/api.md +++ b/common/utils/DOC/loader/devusage/api.md @@ -16,5 +16,5 @@ void * get_shlibmodule_fptr(char *modname, char *fname) ``` Returns a pointer to the symbol `fname`, defined in module `modname`, or `NULL` if the symbol is not found. -[loader home page](../../../loader.md) +[loader home page](../../loader.md) [loader developer home page](../devusage.md) \ No newline at end of file From 36612d8c5d2ed8daadd9271438289b0b6c0dd284 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Thu, 8 Nov 2018 20:27:10 +0100 Subject: [PATCH 22/25] Update arch.md --- common/utils/DOC/loader/arch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/arch.md b/common/utils/DOC/loader/arch.md index c37aedb4ef..6fd1f47e7b 100644 --- a/common/utils/DOC/loader/arch.md +++ b/common/utils/DOC/loader/arch.md @@ -4,4 +4,4 @@ The oai shared library loader is implemented in two source files, located in [co 1. [load_module_shlib.c](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.c) contains the loader implementation 1. [load_module_shlib.h](https://gitlab.eurecom.fr/oai/openairinterface5g/tree/develop/common/utils/load_module_shlib.h) is the loader include file containing both private and public data type definitions. It also contain API prototypes. -[loader home page](..loader.md) \ No newline at end of file +[loader home page](../loader.md) \ No newline at end of file From 9db199269dee4cd6036498a543ffab345afbe495 Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Fri, 9 Nov 2018 08:40:48 +0100 Subject: [PATCH 23/25] Update struct.md --- common/utils/DOC/loader/devusage/struct.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/devusage/struct.md b/common/utils/DOC/loader/devusage/struct.md index e3cfc74993..17504f3866 100644 --- a/common/utils/DOC/loader/devusage/struct.md +++ b/common/utils/DOC/loader/devusage/struct.md @@ -6,5 +6,5 @@ It is defined in include file [ common/util/load_module_shlib.h ](https://gitlab | `fname` | symbol name, is passed to the [`dlsym`](http://man7.org/linux/man-pages/man3/dlsym.3.html) system call performed by the loader to get a pointer to the symbol | I | | `fptr` | pointer to the symbol name, set by the loader. `fptr` is defined as a `int (*fptr)(void)` function type | O | -[loader home page](../..loader.md) +[loader home page](../../loader.md) [loader developer home page](../devusage.md) \ No newline at end of file From 9b4d01f48ff8d1c59b84b57b7aae29b0410b51cb Mon Sep 17 00:00:00 2001 From: Francois TABURET Date: Fri, 9 Nov 2018 08:42:16 +0100 Subject: [PATCH 24/25] Update rtusage.md --- common/utils/DOC/loader/rtusage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/common/utils/DOC/loader/rtusage.md b/common/utils/DOC/loader/rtusage.md index 903d249d65..bf87316e13 100644 --- a/common/utils/DOC/loader/rtusage.md +++ b/common/utils/DOC/loader/rtusage.md @@ -6,7 +6,7 @@ Shared library full names are built by the loader using the format: 1. the < *module version* > and < *path* > optional parameters, are defined at run-time, depending on the configuration. ## loader parameters -The loader is using the [configuration module](../../../config/DOCconfig.md), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. +The loader is using the [configuration module](../../../config/DOC/config.md), and defines global and per library parameters. Global parameters must be specified under the **loader** section and library specific parameters under a **loader.<*module name*>** section. Module specific parameters override the global parameters. ### Global loader parameters | name | type | default | description | |:---:|:---:|:---:|:----| From 4931a300ad234b116cd7cade5cc28b625434b363 Mon Sep 17 00:00:00 2001 From: Cedric Roux Date: Mon, 12 Nov 2018 10:45:44 +0100 Subject: [PATCH 25/25] T: macpdu2wireshark: run live, limit MIB/SIBs recording, cleanup A new option -live has been added to run live (ie. like the 'enb' tracer) and options -live-ip and -live-port to select IP/port of the machine running the eNodeB. Some new options to control MIB and SIBs recording have been added. Some global variables have been removed. --- common/utils/T/tracer/macpdu2wireshark.c | 90 ++++++++++++++++++++---- 1 file changed, 77 insertions(+), 13 deletions(-) diff --git a/common/utils/T/tracer/macpdu2wireshark.c b/common/utils/T/tracer/macpdu2wireshark.c index f65fdf34c3..d9bcb8b7f5 100644 --- a/common/utils/T/tracer/macpdu2wireshark.c +++ b/common/utils/T/tracer/macpdu2wireshark.c @@ -14,10 +14,10 @@ #define DEFAULT_IP "127.0.0.1" #define DEFAULT_PORT 9999 -#define NO_PREAMBLE -1 +#define DEFAULT_LIVE_IP "127.0.0.1" +#define DEFAULT_LIVE_PORT 2021 -int no_sib = 0; -int no_mib = 0; +#define NO_PREAMBLE -1 typedef struct { int socket; @@ -46,6 +46,15 @@ typedef struct { int rar_frame; int rar_subframe; int rar_data; + /* config */ + int no_mib; + int no_sib; + int max_mib; + int max_sib; + int live; + /* runtime vars */ + int cur_mib; + int cur_sib; } ev_data; void trace(ev_data *d, int direction, int rnti_type, int rnti, @@ -104,7 +113,11 @@ void dl(void *_d, event e) { ev_data *d = _d; - if (e.e[d->dl_rnti].i == 0xffff && no_sib) return; + if (e.e[d->dl_rnti].i == 0xffff) { + if (d->no_sib) return; + if (d->max_sib && d->cur_sib == d->max_sib) return; + d->cur_sib++; + } trace(d, DIRECTION_DOWNLINK, e.e[d->dl_rnti].i != 0xffff ? C_RNTI : SI_RNTI, e.e[d->dl_rnti].i, @@ -117,7 +130,9 @@ void mib(void *_d, event e) { ev_data *d = _d; - if (no_mib) return; + if (d->no_mib) return; + if (d->max_mib && d->cur_mib == d->max_mib) return; + d->cur_mib++; trace(d, DIRECTION_DOWNLINK, NO_RNTI, 0, e.e[d->mib_frame].i, e.e[d->mib_subframe].i, @@ -269,9 +284,18 @@ void usage(void) " -ip send packets to this IP address (default %s)\n" " -p send packets to this port (default %d)\n" " -no-mib do not report MIB\n" -" -no-sib do not report SIBs\n", +" -no-sib do not report SIBs\n" +" -max-mib report at maximum n MIB\n" +" -max-sib report at maximum n SIBs\n" +" -live run live\n" +" -live-ip tracee's IP address (default %p)\n" +" -live-port tracee's port (default %d)\n" +"-i and -live are mutually exclusive options. One of them must be provided\n" +"but not both.\n", DEFAULT_IP, - DEFAULT_PORT + DEFAULT_PORT, + DEFAULT_LIVE_IP, + DEFAULT_LIVE_PORT ); exit(1); } @@ -288,6 +312,9 @@ int main(int n, char **v) ev_data d; char *ip = DEFAULT_IP; int port = DEFAULT_PORT; + char *live_ip = DEFAULT_LIVE_IP; + int live_port = DEFAULT_LIVE_PORT; + int live = 0; memset(&d, 0, sizeof(ev_data)); @@ -299,8 +326,17 @@ int main(int n, char **v) { if (i > n-2) usage(); input_filename = v[++i]; continue; } if (!strcmp(v[i], "-ip")) { if (i > n-2) usage(); ip = v[++i]; continue; } if (!strcmp(v[i], "-p")) {if(i>n-2)usage(); port=atoi(v[++i]); continue; } - if (!strcmp(v[i], "-no-mib")) { no_mib = 1; continue; } - if (!strcmp(v[i], "-no-sib")) { no_sib = 1; continue; } + if (!strcmp(v[i], "-no-mib")) { d.no_mib = 1; continue; } + if (!strcmp(v[i], "-no-sib")) { d.no_sib = 1; continue; } + if (!strcmp(v[i], "-max-mib")) + { if (i > n-2) usage(); d.max_mib = atoi(v[++i]); continue; } + if (!strcmp(v[i], "-max-sib")) + { if (i > n-2) usage(); d.max_sib = atoi(v[++i]); continue; } + if (!strcmp(v[i], "-live")) { live = 1; continue; } + if (!strcmp(v[i], "-live-ip")) + { if (i > n-2) usage(); live_ip = v[++i]; continue; } + if (!strcmp(v[i], "-live-port")) + { if (i > n-2) usage(); live_port = atoi(v[++i]); continue; } usage(); } @@ -309,19 +345,47 @@ int main(int n, char **v) exit(1); } - if (input_filename == NULL) { - printf("ERROR: provide an input file (-i)\n"); + if (input_filename == NULL && live == 0) { + printf("ERROR: provide an input file (-i) or run live (-live)\n"); exit(1); } - in = open(input_filename, O_RDONLY); - if (in == -1) { perror(input_filename); return 1; } + if (input_filename != NULL && live != 0) { + printf("ERROR: cannot use both -i and -live\n"); + exit(1); + } + + if (live == 0) { + in = open(input_filename, O_RDONLY); + if (in == -1) { perror(input_filename); return 1; } + } else + in = connect_to(live_ip, live_port); database = parse_database(database_filename); load_config_file(database_filename); h = new_handler(database); + if (live) { + char mt = 1; + int number_of_events = number_of_ids(database); + int *is_on = calloc(number_of_events, sizeof(int)); + if (is_on == NULL) { printf("ERROR: out of memory\n"); exit(1); } + on_off(database, "ENB_MAC_UE_UL_PDU_WITH_DATA", is_on, 1); + on_off(database, "ENB_MAC_UE_DL_PDU_WITH_DATA", is_on, 1); + on_off(database, "ENB_PHY_MIB", is_on, 1); + on_off(database, "ENB_PHY_INITIATE_RA_PROCEDURE", is_on, 1); + on_off(database, "ENB_MAC_UE_DL_RAR_PDU_WITH_DATA", is_on, 1); + /* activate selected traces */ + if (socket_send(in, &mt, 1) == -1 || + socket_send(in, &number_of_events, sizeof(int)) == -1 || + socket_send(in, is_on, number_of_events * sizeof(int)) == -1) { + printf("ERROR: socket_send failed\n"); + exit(1); + } + free(is_on); + } + ul_id = event_id_from_name(database, "ENB_MAC_UE_UL_PDU_WITH_DATA"); dl_id = event_id_from_name(database, "ENB_MAC_UE_DL_PDU_WITH_DATA"); mib_id = event_id_from_name(database, "ENB_PHY_MIB");