Merge remote-tracking branch 'origin/ci-ue-timing-stats' into integration_2026_w25

CI: Add UE timing phytest (#188)

Add a new XML file to also measure UE timings, similarly how we do with
gNB.
Reviewed-by: Robert Schmidt <robert.schmidt@openairinterface.org>

ci-scripts/cls_analysis.py

@@ -95,13 +95,13 @@ class Analysis():
 		test_summary['Nbfail'] =  nb_failed
 		return nb_failed == 0, test_summary, test_result
 
-	def analyze_rt_stats(thresholds, L1_stats, MAC_stats):
+	def analyze_rt_stats(thresholds, stat_files):
 		with open(thresholds, 'r') as f:
 			datalog_rt_stats = yaml.load(f, Loader=yaml.FullLoader)
 
 		rt_keys = datalog_rt_stats['Ref']
 		real_time_stats = {}
-		for sf in [L1_stats, MAC_stats]:
+		for sf in stat_files:
 			with open(sf, 'r') as f:
 				for line in f.readlines():
 					for k in rt_keys:

ci-scripts/cls_containerize.py

@@ -644,7 +644,7 @@ class Containerize():
 			logging.error('\u001B[1m Undeploying objects Failed\u001B[0m')
 		return success
 
-	def AnalyzeRTStatsObject(self, HTML, node, ctx, thresholds, service=None):
+	def AnalyzeRTStatsObject(self, HTML, node, ctx, thresholds, service=None, stats_files=None):
 		logging.info(f'Analyzing realtime stats from server: {node}')
 		yaml = self.yamlPath.strip('/')
 		wd = f'{self.workspace}/{yaml}'
@@ -660,12 +660,20 @@ class Containerize():
 				raise RuntimeError(f"Requested service {s} not found among services: {deployed_services}")
 			logging.info(f"Analyzing deployed service '{s}'")
 			# similar to BuildRunTests(), use docker cp to avoid problems with permissions
-			cmd.run(f'docker compose -f {wd_yaml} cp {s}:/opt/oai-gnb/nrL1_stats.log {wd}/')
-			l1_file = archiveArtifact(cmd, ctx, f"{wd}/nrL1_stats.log")
-			cmd.run(f'docker compose -f {wd_yaml} cp {s}:/opt/oai-gnb/nrMAC_stats.log {wd}/')
-			mac_file = archiveArtifact(cmd, ctx, f"{wd}/nrMAC_stats.log")
+			local_files = []
+			for sf in stats_files:
+				basename = os.path.basename(sf)
+				ret = cmd.run(f'docker compose -f {wd_yaml} cp {s}:{sf} {wd}/')
+				if ret.returncode != 0:
+					logging.error(f"Cannot retrieve {s}:{sf}")
+					return False
+				file = archiveArtifact(cmd, ctx, f"{wd}/{basename}")
+				if not file:
+					logging.error(f"Cannot retrieve file {basename}")
+					return False
+				local_files.append(file)
 
 		logging.info(f"check against thresholds from {thresholds}")
-		success, datalog_rt_stats = cls_analysis.Analysis.analyze_rt_stats(thresholds, l1_file, mac_file)
+		success, datalog_rt_stats = cls_analysis.Analysis.analyze_rt_stats(thresholds, local_files)
 		HTML.CreateHtmlDataLogTable(datalog_rt_stats)
 		return success

ci-scripts/conf_files/gnb.band79.106prb.vrtsim.phytest-dora.conf

+# SPDX-License-Identifier: LicenseRef-CSSL-1.0
+
+Active_gNBs = ( "gNB-OAI");
+# Asn1_verbosity, choice in: none, info, annoying
+Asn1_verbosity = "none";
+
+gNBs =
+(
+ {
+    ////////// Identification parameters:
+    gNB_ID    =  0xe00;
+    gNB_name  =  "gNB-OAI";
+
+    // Tracking area code, 0x0000 and 0xfffe are reserved values
+    tracking_area_code  =  1;
+    plmn_list = ({mcc = 208; mnc = 99; mnc_length = 2;});
+
+    tr_s_preference     = "local_mac"
+
+    ////////// Physical parameters:
+
+    min_rxtxtime = 6;
+
+    servingCellConfigCommon = (
+    {
+ #spCellConfigCommon
+
+      physCellId                                                    = 0;
+
+#  downlinkConfigCommon
+    #frequencyInfoDL
+      # this is 4412.64 MHz
+      absoluteFrequencySSB                                             = 694176;
+      dl_frequencyBand                                                 = 79;
+      # this is 4400.94 MHz
+      dl_absoluteFrequencyPointA                                       = 693396;
+      #scs-SpecificCarrierList
+        dl_offstToCarrier                                              = 0;
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        dl_subcarrierSpacing                                           = 1;
+        dl_carrierBandwidth                                            = 106;
+     #initialDownlinkBWP
+      #genericParameters
+        # this is RBstart=41,L=24 (275*(L-1))+RBstart
+        initialDLBWPlocationAndBandwidth                                        = 6368;
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        initialDLBWPsubcarrierSpacing                                           = 1;
+      #pdcch-ConfigCommon
+        initialDLBWPcontrolResourceSetZero                                      = 12;
+        initialDLBWPsearchSpaceZero                                             = 0;
+
+  #uplinkConfigCommon
+     #frequencyInfoUL
+      ul_frequencyBand                                                 = 79;
+      #scs-SpecificCarrierList
+      ul_offstToCarrier                                              = 0;
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+      ul_subcarrierSpacing                                           = 1;
+      ul_carrierBandwidth                                            = 106;
+      pMax                                                          = 20;
+     #initialUplinkBWP
+      #genericParameters
+        initialULBWPlocationAndBandwidth                                        = 6368;
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+        initialULBWPsubcarrierSpacing                                           = 1;
+      #rach-ConfigCommon
+        #rach-ConfigGeneric
+          prach_ConfigurationIndex                                  = 98;
+#prach_msg1_FDM
+#0 = one, 1=two, 2=four, 3=eight
+          prach_msg1_FDM                                            = 0;
+          prach_msg1_FrequencyStart                                 = 0;
+          zeroCorrelationZoneConfig                                 = 13;
+          preambleReceivedTargetPower                               = -118;
+#preamblTransMax (0...10) = (3,4,5,6,7,8,10,20,50,100,200)
+          preambleTransMax                                          = 6;
+#powerRampingStep
+# 0=dB0,1=dB2,2=dB4,3=dB6
+        powerRampingStep                                            = 1;
+#ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR
+#1=oneeighth,2=onefourth,3=half,4=one,5=two,6=four,7=eight,8=sixteen
+        ssb_perRACH_OccasionAndCB_PreamblesPerSSB_PR                = 4;
+#one (0..15) 4,8,12,16,...60,64
+        ssb_perRACH_OccasionAndCB_PreamblesPerSSB                   = 15;
+#ra_ContentionResolutionTimer
+#(0..7) 8,16,24,32,40,48,56,64
+        ra_ContentionResolutionTimer                                = 7;
+        rsrp_ThresholdSSB                                           = 19;
+#prach-RootSequenceIndex_PR
+#1 = 839, 2 = 139
+        prach_RootSequenceIndex_PR                                  = 2;
+        prach_RootSequenceIndex                                     = 1;
+        # SCS for msg1, can only be 15 for 30 kHz < 6 GHz, takes precendence over the one derived from prach-ConfigIndex
+        #
+        msg1_SubcarrierSpacing                                      = 1,
+# restrictedSetConfig
+# 0=unrestricted, 1=restricted type A, 2=restricted type B
+        restrictedSetConfig                                         = 0,
+
+        msg3_DeltaPreamble                                          = 1;
+        p0_NominalWithGrant                                         =-90;
+
+# pucch-ConfigCommon setup :
+# pucchGroupHopping
+# 0 = neither, 1= group hopping, 2=sequence hopping
+        pucchGroupHopping                                           = 0;
+        hoppingId                                                   = 40;
+        p0_nominal                                                  = -90;
+
+      ssb_PositionsInBurst_Bitmap                                   = 1;
+
+# ssb_periodicityServingCell
+# 0 = ms5, 1=ms10, 2=ms20, 3=ms40, 4=ms80, 5=ms160, 6=spare2, 7=spare1
+      ssb_periodicityServingCell                                    = 2;
+
+# dmrs_TypeA_position
+# 0 = pos2, 1 = pos3
+      dmrs_TypeA_Position                                           = 0;
+
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+      subcarrierSpacing                                             = 1;
+
+
+  #tdd-UL-DL-ConfigurationCommon
+# subcarrierSpacing
+# 0=kHz15, 1=kHz30, 2=kHz60, 3=kHz120
+      referenceSubcarrierSpacing                                    = 1;
+      # pattern1
+      # dl_UL_TransmissionPeriodicity
+      # 0=ms0p5, 1=ms0p625, 2=ms1, 3=ms1p25, 4=ms2, 5=ms2p5, 6=ms5, 7=ms10
+      dl_UL_TransmissionPeriodicity                                 = 6;
+      nrofDownlinkSlots                                             = 7;
+      nrofDownlinkSymbols                                           = 6;
+      nrofUplinkSlots                                               = 2;
+      nrofUplinkSymbols                                             = 4;
+
+      ssPBCH_BlockPower                                             = -25;
+  }
+
+  );
+
+
+    # ------- SCTP 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.26"; port = 36412; });
+
+    NETWORK_INTERFACES :
+    {
+
+        GNB_IPV4_ADDRESS_FOR_S1_MME              = "192.168.12.111/24";
+        GNB_IPV4_ADDRESS_FOR_S1U                 = "192.168.12.111/24";
+        GNB_PORT_FOR_S1U                         = 2152; # Spec 2152
+    };
+  }
+);
+
+MACRLCs = (
+{
+  tr_s_preference = "local_L1";
+  tr_n_preference = "local_RRC";
+});
+
+L1s = (
+{
+  tr_n_preference = "local_mac";
+});
+
+RUs = (
+{
+  local_rf       = "yes"
+  nb_tx          = 1
+  nb_rx          = 1
+  att_tx         = 0
+  att_rx         = 0;
+  bands          = [7];
+  max_pdschReferenceSignalPower = -27;
+  max_rxgain                    = 50;
+  eNB_instances  = [0];
+});
+
+
+security = {
+  # preferred ciphering algorithms
+  # the first one of the list that an UE supports in chosen
+  # valid values: nea0, nea1, nea2, nea3
+  ciphering_algorithms = ( "nea0" );
+
+  # preferred integrity algorithms
+  # the first one of the list that an UE supports in chosen
+  # valid values: nia0, nia1, nia2, nia3
+  integrity_algorithms = ( "nia2", "nia0" );
+
+  # setting 'drb_ciphering' to "no" disables ciphering for DRBs, no matter
+  # what 'ciphering_algorithms' configures; same thing for 'drb_integrity'
+  drb_ciphering = "yes";
+  drb_integrity = "no";
+};
+
+log_config :
+{
+  global_log_level                      ="info";
+  hw_log_level                          ="info";
+  phy_log_level                         ="info";
+  mac_log_level                         ="info";
+  rlc_log_level                         ="info";
+  pdcp_log_level                        ="info";
+  rrc_log_level                         ="info";
+};
+

ci-scripts/datalog_rt_stats.gnb.40.vrtsim.yaml

+# SPDX-License-Identifier: LicenseRef-CSSL-1.0
+
+#this is a configuration file
+#used to build real time processing statistics
+#for 5G NR phy test (gNB terminate)
+Title : gNB Processing Time (us) from datalog_rt_stats.default.yaml
+ColNames :
+  - Metric
+  - Average; Max; Count
+  - Average vs Reference Deviation (Reference Value; Acceptability Deviation Threshold)
+Ref :
+  L1 Tx processing : 190.0
+  DLSCH encoding : 120.0
+  L1 Rx processing : 235.0
+  UL segments decoding : 120.0
+  PUSCH inner-receiver : 150.0
+  UL Indication : 2.0
+  Slot Indication : 10.0
+  feprx : 40.0
+  feptx_ofdm (per port, half_slot) : 30
+  feptx_total : 52
+DeviationThreshold :
+  L1 Tx processing : 0.25
+  DLSCH encoding : 0.25
+  L1 Rx processing : 0.25
+  UL segments decoding : 0.25
+  PUSCH inner-receiver : 0.25
+  UL Indication : 1.00
+  Slot Indication : 0.50
+  feprx : 0.25
+  feptx_ofdm (per port, half_slot) : 0.25
+  feptx_total : 0.25

ci-scripts/datalog_rt_stats.ue.40.vrtsim.yaml

+# SPDX-License-Identifier: LicenseRef-CSSL-1.0
+
+#this is a configuration file
+#used to build real time processing statistics
+#for 5G NR phy test (gNB terminate)
+Title : UE Processing Time (us) from datalog_rt_stats.ue.40.vrtsim.yaml
+ColNames :
+  - Metric
+  - Average; Max; Count
+  - Average vs Reference Deviation (Reference Value; Acceptability Deviation Threshold)
+Ref :
+  RX_PDSCH_STATS : 62.0
+  DLSCH_RX_PDCCH_STATS : 30.5
+  RX_DFT_STATS : 5.5
+  DLSCH_CHANNEL_ESTIMATION_STATS : 39.0
+  DLSCH_DECODING_STATS : 178.0
+  DLSCH_LDPC_DECODING_STATS : 78.0
+  DLSCH_LLR_STATS : 25.0
+  DLSCH_LAYER_DEMAPPING : 8.5
+  DLSCH_PROCEDURES_STATS : 188.0
+  PHY_PROC_TX : 158.0
+  PUSCH_PROC_STATS : 167.0
+  ULSCH_LDPC_ENCODING_STATS : 43.0
+  ULSCH_ENCODING_STATS : 121.0
+  OFDM_MOD_STATS : 44.5
+DeviationThreshold :
+  RX_PDSCH_STATS : 0.25
+  DLSCH_RX_PDCCH_STATS : 0.25
+  RX_DFT_STATS : 0.25
+  DLSCH_CHANNEL_ESTIMATION_STATS : 0.25
+  DLSCH_DECODING_STATS : 0.25
+  DLSCH_LDPC_DECODING_STATS : 0.25
+  DLSCH_LLR_STATS : 0.25
+  DLSCH_LAYER_DEMAPPING : 0.5
+  DLSCH_PROCEDURES_STATS : 0.25
+  PHY_PROC_TX : 0.25
+  PUSCH_PROC_STATS : 0.25
+  ULSCH_LDPC_ENCODING_STATS : 0.25
+  ULSCH_ENCODING_STATS : 0.25
+  OFDM_MOD_STATS : 0.25

ci-scripts/main.py

@@ -245,7 +245,8 @@ def ExecuteActionWithParam(action, ctx, node):
 	elif action == 'AnalyzeRTStats_Object':
 		yaml = test.findtext('stats_cfg')
 		service = test.findtext('service')
-		success = CONTAINERS.AnalyzeRTStatsObject(HTML, node, ctx, yaml, service)
+		stats_files = (test.findtext('stats_file') or '').split()
+		success = CONTAINERS.AnalyzeRTStatsObject(HTML, node, ctx, yaml, service, stats_files)
 
 	else:
 		logging.warning(f"unknown action {action}, skip step")

ci-scripts/ran.py

@@ -145,6 +145,6 @@ class RANManagement():
 			mac_file = archiveArtifact(cmd, ctx, f"{logdir}/nrMAC_stats.log")
 
 		logging.info(f"check against thresholds from {thresholds}")
-		success, datalog_rt_stats = cls_analysis.Analysis.analyze_rt_stats(thresholds, l1_file, mac_file)
+		success, datalog_rt_stats = cls_analysis.Analysis.analyze_rt_stats(thresholds, [l1_file, mac_file])
 		HTML.CreateHtmlDataLogTable(datalog_rt_stats)
 		return success

ci-scripts/tests/analysis.py

@@ -26,7 +26,7 @@ class TestAnalysis(unittest.TestCase):
 		rtsf = "datalog_rt_stats.100.2x2.yaml"
 		l1f = "tests/analysis/gnb_phytest.success.nrL1.log"
 		macf = "tests/analysis/gnb_phytest.success.nrMAC.log"
-		status, s = cls_analysis.Analysis.analyze_rt_stats(rtsf, l1f, macf)
+		status, s = cls_analysis.Analysis.analyze_rt_stats(rtsf, [l1f, macf])
 		self.assertTrue(status)
 		self.assertEqual(s['Title'], "Processing Time (us) from datalog_rt_stats.100.2x2.yaml")
 		self.assertEqual(s['ColNames'], ["Metric", "Average; Max; Count", "Average vs Reference Deviation (Reference Value; Acceptability Deviation Threshold)"])

ci-scripts/xml_files/gnb_phytest_fhi7.2_docker.xml

@@ -36,6 +36,7 @@
     <desc>Analyze Real-Time Stats</desc>
     <stats_cfg>datalog_rt_stats.100.4x4.fhi72.yaml</stats_cfg>
     <service>oai-gnb</service>
+    <stats_file>/opt/oai-gnb/nrL1_stats.log /opt/oai-gnb/nrMAC_stats.log</stats_file>
     <node>bulbul</node>
   </testCase>
 

ci-scripts/xml_files/gnb_phytest_fhi7.2_docker_cacofonix.xml

@@ -44,6 +44,7 @@
     <desc>Analyze Real-Time Stats</desc>
     <stats_cfg>datalog_rt_stats.100.2x2.fhi72.cacofonix.yaml</stats_cfg>
     <service>oai-gnb</service>
+    <stats_file>/opt/oai-gnb/nrL1_stats.log /opt/oai-gnb/nrMAC_stats.log</stats_file>
     <node>cacofonix</node>
   </testCase>
 

ci-scripts/xml_files/phytest_vrtsim_40MHz.xml

+<!-- SPDX-License-Identifier: LicenseRef-CSSL-1.0 -->
+
+<testCaseList>
+  <htmlTabRef>PHY-Test-40-vrtsim</htmlTabRef>
+  <htmlTabName>Timing phytest 40 MHz with vrtsim</htmlTabName>
+  <htmlTabIcon>tasks</htmlTabIcon>
+
+  <testCase>
+    <class>Pull_Cluster_Image</class>
+    <desc>Pull Images from Cluster</desc>
+    <images>oai-gnb oai-nr-ue</images>
+    <node>caracal</node>
+  </testCase>
+
+  <testCase>
+    <class>Create_Workspace</class>
+    <desc>Create new Workspace</desc>
+    <node>caracal</node>
+  </testCase>
+
+  <testCase>
+    <class>Deploy_Object</class>
+    <desc>Initialize gNB</desc>
+    <node>caracal</node>
+    <yaml_path>ci-scripts/yaml_files/phytest_vrtsim_40MHz</yaml_path>
+    <services>oai-gnb</services>
+  </testCase>
+
+  <testCase>
+    <class>Deploy_Object</class>
+    <desc>Initialize UE</desc>
+    <node>caracal</node>
+    <yaml_path>ci-scripts/yaml_files/phytest_vrtsim_40MHz</yaml_path>
+    <services>oai-nr-ue</services>
+  </testCase>
+
+  <testCase>
+    <class>IdleSleep</class>
+    <desc>Sleep</desc>
+    <idle_sleep_time_in_sec>60</idle_sleep_time_in_sec>
+  </testCase>
+
+  <testCase>
+    <class>AnalyzeRTStats_Object</class>
+    <desc>Analyze Real-Time Stats on gNB</desc>
+    <always_exec>true</always_exec>
+    <stats_cfg>datalog_rt_stats.gnb.40.vrtsim.yaml</stats_cfg>
+    <service>oai-gnb</service>
+    <stats_file>/opt/oai-gnb/nrL1_stats.log /opt/oai-gnb/nrMAC_stats.log</stats_file>
+    <node>caracal</node>
+  </testCase>
+
+  <testCase>
+    <class>AnalyzeRTStats_Object</class>
+    <desc>Analyze Real-Time Stats on UE</desc>
+    <always_exec>true</always_exec>
+    <stats_cfg>datalog_rt_stats.ue.40.vrtsim.yaml</stats_cfg>
+    <service>oai-nr-ue</service>
+    <stats_file>/opt/oai-nr-ue/nrL1_UE_stats-0.log</stats_file>
+    <node>caracal</node>
+  </testCase>
+
+  <testCase>
+    <class>Undeploy_Object</class>
+    <node>caracal</node>
+    <always_exec>true</always_exec>
+    <desc>Terminate gNB</desc>
+    <yaml_path>ci-scripts/yaml_files/phytest_vrtsim_40MHz</yaml_path>
+    <analysis>
+      <services>oai-gnb=EndsWithBye oai-nr-ue=EndsWithBye</services>
+    </analysis>
+  </testCase>
+
+  <testCase>
+    <class>Clean_Test_Server_Images</class>
+    <always_exec>true</always_exec>
+    <desc>Clean Test Images on Test Server</desc>
+    <node>caracal</node>
+    <images>oai-nr-ue oai-gnb</images>
+  </testCase>
+
+</testCaseList>

ci-scripts/yaml_files/phytest_vrtsim_40MHz/docker-compose.yaml

+# SPDX-License-Identifier: MIT
+
+services:
+    oai-gnb:
+        image: ${REGISTRY-oaisoftwarealliance/}${GNB_IMG:-oai-gnb}:${TAG:-develop}
+        container_name: rfsim5g-oai-gnb
+        cap_drop:
+            - ALL
+        cap_add:
+            - SYS_NICE
+        environment:
+            USE_ADDITIONAL_OPTIONS: --phy-test --device.name vrtsim --vrtsim.role server -q -U 768 -T 106 -t 23 -D 127 -m 28 -M 106 --log_config.global_log_options level,nocolor,time
+            ASAN_OPTIONS: detect_leaks=0
+        ipc: host
+        volumes:
+            - ../../conf_files/gnb.band79.106prb.vrtsim.phytest-dora.conf:/opt/oai-gnb/etc/gnb.conf
+            - rrc.config:/opt/oai-gnb/
+            - tmp_data:/tmp/
+        healthcheck:
+            test: /bin/bash -c "pgrep nr-softmodem"
+            interval: 10s
+            timeout: 5s
+            retries: 5
+
+    oai-nr-ue:
+        image: ${REGISTRY-oaisoftwarealliance/}${NRUE_IMG:-oai-nr-ue}:${TAG:-develop}
+        container_name: rfsim5g-oai-nr-ue
+        cap_drop:
+            - ALL
+        cap_add:
+            - SYS_NICE
+        environment:
+            USE_ADDITIONAL_OPTIONS: --phy-test --reconfig-file etc/rrc/reconfig.raw --rbconfig-file etc/rrc/rbconfig.raw --device.name vrtsim --vrtsim.role client -q --log_config.global_log_options level,nocolor,time
+            ASAN_OPTIONS: detect_leaks=0
+        devices:
+            - /dev/net/tun:/dev/net/tun
+        ipc: host
+        volumes:
+            - ../../conf_files/nrue.uicc.conf:/opt/oai-nr-ue/etc/nr-ue.conf
+            - rrc.config:/opt/oai-nr-ue/etc/rrc/
+            - tmp_data:/tmp/
+        depends_on:
+            - oai-gnb
+        healthcheck:
+            test: /bin/bash -c "pgrep nr-uesoftmodem"
+            interval: 10s
+            timeout: 5s
+            retries: 5
+
+volumes:
+    rrc.config:
+    tmp_data: