Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 1 | # osmo_gsm_tester: specifics for running an SRS UE process |
| 2 | # |
| 3 | # Copyright (C) 2020 by sysmocom - s.f.m.c. GmbH |
| 4 | # |
| 5 | # Author: Pau Espin Pedrol <pespin@sysmocom.de> |
| 6 | # |
| 7 | # This program is free software: you can redistribute it and/or modify |
| 8 | # it under the terms of the GNU General Public License as |
| 9 | # published by the Free Software Foundation, either version 3 of the |
| 10 | # License, or (at your option) any later version. |
| 11 | # |
| 12 | # This program is distributed in the hope that it will be useful, |
| 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 15 | # GNU General Public License for more details. |
| 16 | # |
| 17 | # You should have received a copy of the GNU General Public License |
| 18 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 19 | |
| 20 | import os |
| 21 | import pprint |
Andre Puschmann | 419a662 | 2020-05-27 18:46:12 +0200 | [diff] [blame] | 22 | import re |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 23 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 24 | from ..core import log, util, config, template, process, remote |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 25 | from ..core import schema |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 26 | from .run_node import RunNode |
| 27 | from .ms import MS |
Andre Puschmann | f14ff81 | 2020-06-19 15:47:32 +0200 | [diff] [blame] | 28 | from .srslte_common import srslte_common |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 29 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 30 | def rf_type_valid(rf_type_str): |
Pau Espin Pedrol | 12ae6d7 | 2020-04-01 14:12:10 +0200 | [diff] [blame] | 31 | return rf_type_str in ('zmq', 'uhd', 'soapy', 'bladerf') |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 32 | |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 33 | def on_register_schemas(): |
| 34 | resource_schema = { |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 35 | 'rf_dev_type': schema.STR, |
| 36 | 'rf_dev_args': schema.STR, |
Andre Puschmann | b5f0444 | 2020-10-12 16:57:10 +0200 | [diff] [blame] | 37 | 'rf_dev_sync': schema.STR, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 38 | 'num_carriers': schema.UINT, |
Pau Espin Pedrol | e592de8 | 2020-06-15 17:01:16 +0200 | [diff] [blame] | 39 | 'additional_args[]': schema.STR, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 40 | 'airplane_t_on_ms': schema.INT, |
| 41 | 'airplane_t_off_ms': schema.INT, |
| 42 | 'tx_gain': schema.UINT, |
| 43 | 'rx_gain': schema.UINT, |
Andre Puschmann | e3a1910 | 2020-10-06 09:52:46 +0200 | [diff] [blame] | 44 | 'freq_offset': schema.INT, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 45 | } |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 46 | for key, val in RunNode.schema().items(): |
| 47 | resource_schema['run_node.%s' % key] = val |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 48 | schema.register_resource_schema('modem', resource_schema) |
| 49 | |
| 50 | config_schema = { |
| 51 | 'enable_pcap': schema.BOOL_STR, |
Andre Puschmann | 82ced3f | 2020-06-18 14:52:39 +0200 | [diff] [blame] | 52 | 'log_all_level': schema.STR, |
Pau Espin Pedrol | ea8c3d4 | 2020-05-04 12:05:05 +0200 | [diff] [blame] | 53 | } |
| 54 | schema.register_config_schema('modem', config_schema) |
| 55 | |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 56 | #reference: srsLTE.git srslte_symbol_sz() |
| 57 | def num_prb2symbol_sz(num_prb): |
Andre Puschmann | 0a50110 | 2020-06-02 22:35:27 +0200 | [diff] [blame] | 58 | if num_prb == 6: |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 59 | return 128 |
Andre Puschmann | 0a50110 | 2020-06-02 22:35:27 +0200 | [diff] [blame] | 60 | if num_prb == 50: |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 61 | return 768 |
Andre Puschmann | 0a50110 | 2020-06-02 22:35:27 +0200 | [diff] [blame] | 62 | if num_prb == 75: |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 63 | return 1024 |
Andre Puschmann | 0a50110 | 2020-06-02 22:35:27 +0200 | [diff] [blame] | 64 | return 1536 |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 65 | |
| 66 | def num_prb2base_srate(num_prb): |
| 67 | return num_prb2symbol_sz(num_prb) * 15 * 1000 |
| 68 | |
Andre Puschmann | f14ff81 | 2020-06-19 15:47:32 +0200 | [diff] [blame] | 69 | class srsUE(MS, srslte_common): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 70 | |
| 71 | REMOTE_DIR = '/osmo-gsm-tester-srsue' |
| 72 | BINFILE = 'srsue' |
| 73 | CFGFILE = 'srsue.conf' |
| 74 | PCAPFILE = 'srsue.pcap' |
| 75 | LOGFILE = 'srsue.log' |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 76 | METRICSFILE = 'srsue_metrics.csv' |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 77 | |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 78 | def __init__(self, testenv, conf): |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 79 | self._run_node = RunNode.from_conf(conf.get('run_node', {})) |
| 80 | super().__init__('srsue_%s' % self.addr(), conf) |
Andre Puschmann | 99fb78b | 2020-09-14 18:14:15 +0200 | [diff] [blame] | 81 | srslte_common.__init__(self) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 82 | self.enb = None |
| 83 | self.run_dir = None |
| 84 | self.config_file = None |
| 85 | self.log_file = None |
| 86 | self.pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 87 | self.metrics_file = None |
Andre Puschmann | 7c1c8d6 | 2020-06-18 10:05:31 +0200 | [diff] [blame] | 88 | self.have_metrics_file = False |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 89 | self.process = None |
| 90 | self.rem_host = None |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 91 | self.remote_inst = None |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 92 | self.remote_run_dir = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 93 | self.remote_config_file = None |
| 94 | self.remote_log_file = None |
| 95 | self.remote_pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 96 | self.remote_metrics_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 97 | self.enable_pcap = False |
Andre Puschmann | 333b868 | 2020-04-20 20:42:15 +0200 | [diff] [blame] | 98 | self.num_carriers = 1 |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 99 | self.testenv = testenv |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 100 | self._additional_args = [] |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 101 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 102 | raise log.Error('Invalid rf_dev_type=%s' % conf.get('rf_dev_type', None)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 103 | |
| 104 | def cleanup(self): |
| 105 | if self.process is None: |
| 106 | return |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 107 | if self._run_node.is_local(): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 108 | return |
Andre Puschmann | 26890f3 | 2020-05-21 14:34:55 +0200 | [diff] [blame] | 109 | |
| 110 | # Make sure we give the UE time to tear down |
| 111 | self.sleep_after_stop() |
| 112 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 113 | # copy back files (may not exist, for instance if there was an early error of process): |
Andre Puschmann | 7c1c8d6 | 2020-06-18 10:05:31 +0200 | [diff] [blame] | 114 | self.scp_back_metrics(raiseException=False) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 115 | try: |
| 116 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 117 | except Exception as e: |
| 118 | self.log(repr(e)) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 119 | if self.enable_pcap: |
| 120 | try: |
| 121 | self.rem_host.scpfrom('scp-back-pcap', self.remote_pcap_file, self.pcap_file) |
| 122 | except Exception as e: |
| 123 | self.log(repr(e)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 124 | |
Andre Puschmann | f14ff81 | 2020-06-19 15:47:32 +0200 | [diff] [blame] | 125 | # Collect KPIs for each TC |
| 126 | self.testenv.test().set_kpis(self.get_kpis()) |
| 127 | |
Andre Puschmann | 7c1c8d6 | 2020-06-18 10:05:31 +0200 | [diff] [blame] | 128 | def scp_back_metrics(self, raiseException=True): |
| 129 | ''' Copy back metrics only if they have not been copied back yet ''' |
| 130 | if not self.have_metrics_file: |
| 131 | # file is not properly flushed until the process has stopped. |
| 132 | if self.running(): |
| 133 | self.stop() |
| 134 | |
| 135 | # only SCP back if not running locally |
| 136 | if not self._run_node.is_local(): |
| 137 | try: |
| 138 | self.rem_host.scpfrom('scp-back-metrics', self.remote_metrics_file, self.metrics_file) |
| 139 | except Exception as e: |
| 140 | if raiseException: |
| 141 | self.err('Failed copying back metrics file from remote host') |
| 142 | raise e |
| 143 | else: |
| 144 | # only log error |
| 145 | self.log(repr(e)) |
| 146 | # make sure to only call it once |
| 147 | self.have_metrics_file = True |
| 148 | else: |
| 149 | self.dbg('Metrics have already been copied back') |
| 150 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 151 | def netns(self): |
| 152 | return "srsue1" |
| 153 | |
| 154 | def connect(self, enb): |
| 155 | self.log('Starting srsue') |
| 156 | self.enb = enb |
Pau Espin Pedrol | 2a2d846 | 2020-05-11 10:56:52 +0200 | [diff] [blame] | 157 | self.run_dir = util.Dir(self.testenv.test().get_run_dir().new_dir(self.name())) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 158 | self.configure() |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 159 | if self._run_node.is_local(): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 160 | self.start_locally() |
| 161 | else: |
| 162 | self.start_remotely() |
| 163 | |
Andre Puschmann | 2e8626f | 2020-03-21 21:18:39 +0100 | [diff] [blame] | 164 | # send t+Enter to enable console trace |
| 165 | self.dbg('Enabling console trace') |
| 166 | self.process.stdin_write('t\n') |
| 167 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 168 | def start_remotely(self): |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 169 | remote_lib = self.remote_inst.child('lib') |
| 170 | remote_binary = self.remote_inst.child('bin', srsUE.BINFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 171 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 172 | self.log('Setting RPATH for srsue') |
| 173 | # srsue binary needs patchelf >= 0.9+52 to avoid failing during patch. OS#4389, patchelf-GH#192. |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 174 | self.rem_host.change_elf_rpath(remote_binary, remote_lib) |
| 175 | |
Pau Espin Pedrol | 27b609f | 2020-05-21 13:21:56 +0200 | [diff] [blame] | 176 | # srsue requires CAP_SYS_ADMIN to jump to net network namespace: netns(CLONE_NEWNET): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 177 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 178 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 179 | self.rem_host.setcap_netsys_admin(remote_binary) |
| 180 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 181 | self.log('Creating netns %s' % self.netns()) |
| 182 | self.rem_host.create_netns(self.netns()) |
| 183 | |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 184 | args = (remote_binary, self.remote_config_file, '--gw.netns=' + self.netns()) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 185 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 186 | |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 187 | self.process = self.rem_host.RemoteProcessSafeExit(srsUE.BINFILE, self.remote_run_dir, args) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 188 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 189 | self.process.launch() |
| 190 | |
| 191 | def start_locally(self): |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 192 | binary = self.inst.child('bin', srsUE.BINFILE) |
| 193 | lib = self.inst.child('lib') |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 194 | env = {} |
| 195 | |
| 196 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 197 | self.log('Setting RPATH for srsue') |
| 198 | util.change_elf_rpath(binary, util.prepend_library_path(lib), self.run_dir.new_dir('patchelf')) |
| 199 | |
Pau Espin Pedrol | 27b609f | 2020-05-21 13:21:56 +0200 | [diff] [blame] | 200 | # srsue requires CAP_SYS_ADMIN to jump to net network namespace: netns(CLONE_NEWNET): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 201 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 202 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 203 | util.setcap_netsys_admin(binary, self.run_dir.new_dir('setcap_netsys_admin')) |
| 204 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 205 | self.log('Creating netns %s' % self.netns()) |
| 206 | util.create_netns(self.netns(), self.run_dir.new_dir('create_netns')) |
| 207 | |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 208 | args = (binary, os.path.abspath(self.config_file), '--gw.netns=' + self.netns()) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 209 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 210 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 211 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 212 | self.testenv.remember_to_stop(self.process) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 213 | self.process.launch() |
| 214 | |
| 215 | def configure(self): |
Pau Espin Pedrol | eddff7c | 2020-05-26 13:55:19 +0200 | [diff] [blame] | 216 | self.inst = util.Dir(os.path.abspath(self.testenv.suite().trial().get_inst('srslte', self._run_node.run_label()))) |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 217 | if not os.path.isdir(self.inst.child('lib')): |
| 218 | raise log.Error('No lib/ in', self.inst) |
| 219 | if not self.inst.isfile('bin', srsUE.BINFILE): |
| 220 | raise log.Error('No %s binary in' % srsUE.BINFILE, self.inst) |
| 221 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 222 | self.config_file = self.run_dir.child(srsUE.CFGFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 223 | self.log_file = self.run_dir.child(srsUE.LOGFILE) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 224 | self.pcap_file = self.run_dir.child(srsUE.PCAPFILE) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 225 | self.metrics_file = self.run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 226 | |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 227 | if not self._run_node.is_local(): |
| 228 | self.rem_host = remote.RemoteHost(self.run_dir, self._run_node.ssh_user(), self._run_node.ssh_addr()) |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 229 | remote_prefix_dir = util.Dir(srsUE.REMOTE_DIR) |
| 230 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 231 | self.remote_run_dir = util.Dir(remote_prefix_dir.child(srsUE.BINFILE)) |
| 232 | self.remote_config_file = self.remote_run_dir.child(srsUE.CFGFILE) |
| 233 | self.remote_log_file = self.remote_run_dir.child(srsUE.LOGFILE) |
| 234 | self.remote_pcap_file = self.remote_run_dir.child(srsUE.PCAPFILE) |
| 235 | self.remote_metrics_file = self.remote_run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 236 | |
| 237 | values = dict(ue=config.get_defaults('srsue')) |
Pau Espin Pedrol | a442cb8 | 2020-05-05 12:54:37 +0200 | [diff] [blame] | 238 | config.overlay(values, dict(ue=self.testenv.suite().config().get('modem', {}))) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 239 | config.overlay(values, dict(ue=self._conf)) |
Pau Espin Pedrol | 0f7f265 | 2020-07-13 12:01:10 +0200 | [diff] [blame] | 240 | config.overlay(values, dict(ue=dict(num_antennas = self.enb.num_ports(), |
| 241 | opc = self.opc()))) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 242 | |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 243 | metricsfile = self.metrics_file if self._run_node.is_local() else self.remote_metrics_file |
| 244 | logfile = self.log_file if self._run_node.is_local() else self.remote_log_file |
| 245 | pcapfile = self.pcap_file if self._run_node.is_local() else self.remote_pcap_file |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 246 | config.overlay(values, dict(ue=dict(metrics_filename=metricsfile, |
| 247 | log_filename=logfile, |
| 248 | pcap_filename=pcapfile))) |
| 249 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 250 | # Convert parsed boolean string to Python boolean: |
| 251 | self.enable_pcap = util.str2bool(values['ue'].get('enable_pcap', 'false')) |
| 252 | config.overlay(values, dict(ue={'enable_pcap': self.enable_pcap})) |
| 253 | |
Andre Puschmann | be50eae | 2020-06-15 22:12:46 +0200 | [diff] [blame] | 254 | self._additional_args = [] |
Pau Espin Pedrol | e592de8 | 2020-06-15 17:01:16 +0200 | [diff] [blame] | 255 | for add_args in values['ue'].get('additional_args', []): |
| 256 | self._additional_args += add_args.split() |
| 257 | |
Andre Puschmann | 333b868 | 2020-04-20 20:42:15 +0200 | [diff] [blame] | 258 | self.num_carriers = int(values['ue'].get('num_carriers', 1)) |
| 259 | |
Andre Puschmann | b5f0444 | 2020-10-12 16:57:10 +0200 | [diff] [blame] | 260 | # Simply pass-through the sync options |
| 261 | config.overlay(values, dict(ue={'rf_dev_sync': values['ue'].get('rf_dev_sync', None)})) |
| 262 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 263 | # We need to set some specific variables programatically here to match IP addresses: |
| 264 | if self._conf.get('rf_dev_type') == 'zmq': |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 265 | base_srate = num_prb2base_srate(self.enb.num_prb()) |
Andre Puschmann | 333b868 | 2020-04-20 20:42:15 +0200 | [diff] [blame] | 266 | # Define all 8 possible RF ports (2x CA with 2x2 MIMO) |
| 267 | rf_dev_args = 'tx_port0=tcp://' + self.addr() + ':2001' \ |
| 268 | + ',tx_port1=tcp://' + self.addr() + ':2003' \ |
| 269 | + ',tx_port2=tcp://' + self.addr() + ':2005' \ |
| 270 | + ',tx_port3=tcp://' + self.addr() + ':2007' \ |
| 271 | + ',rx_port0=tcp://' + self.enb.addr() + ':2000' \ |
| 272 | + ',rx_port1=tcp://' + self.enb.addr() + ':2002' \ |
| 273 | + ',rx_port2=tcp://' + self.enb.addr() + ':2004' \ |
| 274 | + ',rx_port3=tcp://' + self.enb.addr() + ':2006' |
| 275 | |
| 276 | if self.num_carriers == 1: |
| 277 | # Single carrier |
| 278 | if self.enb.num_ports() == 1: |
| 279 | # SISO |
| 280 | rf_dev_args += ',rx_freq0=2630e6,tx_freq0=2510e6' |
| 281 | elif self.enb.num_ports() == 2: |
| 282 | # MIMO |
| 283 | rf_dev_args += ',rx_freq0=2630e6,rx_freq1=2630e6,tx_freq0=2510e6,tx_freq1=2510e6' |
| 284 | elif self.num_carriers == 2: |
| 285 | # 2x CA |
| 286 | if self.enb.num_ports() == 1: |
| 287 | # SISO |
| 288 | rf_dev_args += ',rx_freq0=2630e6,rx_freq1=2650e6,tx_freq0=2510e6,tx_freq1=2530e6' |
| 289 | elif self.enb.num_ports() == 2: |
| 290 | # MIMO |
| 291 | rf_dev_args += ',rx_freq0=2630e6,rx_freq1=2630e6,rx_freq2=2650e6,rx_freq3=2650e6,tx_freq0=2510e6,tx_freq1=2510e6,tx_freq2=2530e6,tx_freq3=2530e6' |
Andre Puschmann | a9fb751 | 2020-09-16 21:16:46 +0200 | [diff] [blame] | 292 | elif self.num_carriers == 4: |
| 293 | # 4x CA |
| 294 | if self.enb.num_ports() == 1: |
| 295 | # SISO |
| 296 | rf_dev_args += ',rx_freq0=2630e6,rx_freq1=2650e6,rx_freq2=2670e6,rx_freq3=2680e6,tx_freq0=2510e6,tx_freq1=2530e6,tx_freq2=2550e6,tx_freq3=2560e6' |
| 297 | elif self.enb.num_ports() == 2: |
| 298 | # MIMO |
| 299 | raise log.Error("4 carriers with MIMO isn't supported") |
| 300 | else: |
| 301 | # flag |
| 302 | raise log.Error('No rx/tx frequencies given for {} carriers' % self.num_carriers) |
Andre Puschmann | 333b868 | 2020-04-20 20:42:15 +0200 | [diff] [blame] | 303 | |
| 304 | rf_dev_args += ',id=ue,base_srate='+ str(base_srate) |
| 305 | config.overlay(values, dict(ue=dict(rf_dev_args=rf_dev_args))) |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 306 | |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 307 | # Set UHD frame size as a function of the cell bandwidth on B2XX |
Pau Espin Pedrol | 6b8f5ae | 2020-04-07 18:51:57 +0200 | [diff] [blame] | 308 | if self._conf.get('rf_dev_type') == 'uhd' and values['ue'].get('rf_dev_args', None) is not None: |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 309 | if 'b200' in values['ue'].get('rf_dev_args'): |
| 310 | rf_dev_args = values['ue'].get('rf_dev_args', '') |
| 311 | rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else '' |
| 312 | |
Andre Puschmann | 0e00f38 | 2020-09-23 17:07:07 +0200 | [diff] [blame] | 313 | if self.enb.num_prb() == 75: |
| 314 | rf_dev_args += 'master_clock_rate=15.36e6,' |
| 315 | |
| 316 | if self.enb.num_ports() == 1: |
| 317 | # SISO config |
| 318 | if self.enb.num_prb() < 25: |
| 319 | rf_dev_args += 'send_frame_size=512,recv_frame_size=512' |
| 320 | elif self.enb.num_prb() == 25: |
| 321 | rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024' |
| 322 | else: |
| 323 | rf_dev_args += '' |
| 324 | else: |
| 325 | # MIMO config |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 326 | rf_dev_args += 'num_recv_frames=64,num_send_frames=64' |
Andre Puschmann | 0e00f38 | 2020-09-23 17:07:07 +0200 | [diff] [blame] | 327 | # For the UE the otw12 format doesn't seem to work very well |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 328 | |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 329 | config.overlay(values, dict(ue=dict(rf_dev_args=rf_dev_args))) |
| 330 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 331 | self.dbg('SRSUE CONFIG:\n' + pprint.pformat(values)) |
| 332 | |
| 333 | with open(self.config_file, 'w') as f: |
| 334 | r = template.render(srsUE.CFGFILE, values) |
| 335 | self.dbg(r) |
| 336 | f.write(r) |
| 337 | |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 338 | if not self._run_node.is_local(): |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 339 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 340 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
Pau Espin Pedrol | 0d64f16 | 2020-05-25 15:44:09 +0200 | [diff] [blame] | 341 | self.rem_host.recreate_remote_dir(self.remote_run_dir) |
Pau Espin Pedrol | 0e6ab42 | 2020-04-16 15:40:22 +0200 | [diff] [blame] | 342 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 343 | |
Andre Puschmann | 419a662 | 2020-05-27 18:46:12 +0200 | [diff] [blame] | 344 | def is_rrc_connected(self): |
| 345 | ''' Check whether UE is RRC connected using console message ''' |
| 346 | pos_connected = (self.process.get_stdout() or '').rfind('RRC Connected') |
| 347 | pos_released = (self.process.get_stdout() or '').rfind('RRC IDLE') |
| 348 | return pos_connected > pos_released |
| 349 | |
| 350 | def is_registered(self, mcc_mnc=None): |
| 351 | ''' Checks if UE is EMM registered ''' |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 352 | return 'Network attach successful.' in (self.process.get_stdout() or '') |
| 353 | |
Andre Puschmann | 419a662 | 2020-05-27 18:46:12 +0200 | [diff] [blame] | 354 | def get_assigned_addr(self, ipv6=False): |
| 355 | if ipv6: |
| 356 | raise log.Error('IPv6 not implemented!') |
| 357 | else: |
| 358 | stdout_lines = (self.process.get_stdout() or '').splitlines() |
| 359 | for line in reversed(stdout_lines): |
| 360 | if line.find('Network attach successful. IP: ') != -1: |
| 361 | ipv4_addr = re.findall( r'[0-9]+(?:\.[0-9]+){3}', line) |
| 362 | return ipv4_addr[0] |
| 363 | return None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 364 | |
| 365 | def running(self): |
| 366 | return not self.process.terminated() |
| 367 | |
| 368 | def addr(self): |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 369 | return self._run_node.run_addr() |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 370 | |
| 371 | def run_node(self): |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 372 | return self._run_node |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 373 | |
| 374 | def run_netns_wait(self, name, popen_args): |
Pau Espin Pedrol | 5f826be | 2020-05-26 13:48:10 +0200 | [diff] [blame] | 375 | if self._run_node.is_local(): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 376 | proc = process.NetNSProcess(name, self.run_dir.new_dir(name), self.netns(), popen_args, env={}) |
| 377 | else: |
| 378 | proc = self.rem_host.RemoteNetNSProcess(name, self.netns(), popen_args, env={}) |
| 379 | proc.launch_sync() |
Pau Espin Pedrol | 2bcd346 | 2020-03-05 18:30:37 +0100 | [diff] [blame] | 380 | return proc |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 381 | |
Andre Puschmann | 3c978fe | 2020-05-27 21:38:59 +0200 | [diff] [blame] | 382 | def _get_counter_stdout(self, keyword): |
| 383 | # Match stdout against keyword |
Pau Espin Pedrol | eaefe6b | 2020-04-20 13:29:59 +0200 | [diff] [blame] | 384 | n = 0 |
| 385 | stdout_lines = (self.process.get_stdout() or '').splitlines() |
| 386 | for l in stdout_lines: |
Andre Puschmann | 3c978fe | 2020-05-27 21:38:59 +0200 | [diff] [blame] | 387 | if keyword in l: |
Pau Espin Pedrol | eaefe6b | 2020-04-20 13:29:59 +0200 | [diff] [blame] | 388 | n += 1 |
| 389 | return n |
| 390 | |
| 391 | def get_counter(self, counter_name): |
| 392 | if counter_name == 'handover_success': |
Andre Puschmann | 3c978fe | 2020-05-27 21:38:59 +0200 | [diff] [blame] | 393 | return self._get_counter_stdout('HO successful') |
| 394 | if counter_name == 'prach_sent': |
| 395 | return self._get_counter_stdout('Random Access Transmission') |
| 396 | if counter_name == 'paging_received': |
| 397 | return self._get_counter_stdout('S-TMSI match in paging message') |
| 398 | if counter_name == 'reestablishment_attempts': |
| 399 | return self._get_counter_stdout('RRC Connection Reestablishment') |
| 400 | if counter_name == 'reestablishment_ok': |
| 401 | return self._get_counter_stdout('Reestablishment OK') |
| 402 | if counter_name == 'rrc_connected_transitions': |
| 403 | return self._get_counter_stdout('RRC Connected') |
| 404 | if counter_name == 'rrc_idle_transitions': |
| 405 | return self._get_counter_stdout('RRC IDLE') |
Pau Espin Pedrol | eaefe6b | 2020-04-20 13:29:59 +0200 | [diff] [blame] | 406 | raise log.Error('counter %s not implemented!' % counter_name) |
| 407 | |
Andre Puschmann | 2cfa4a3 | 2020-05-22 16:15:25 +0200 | [diff] [blame] | 408 | def verify_metric(self, value, operation='avg', metric='dl_brate', criterion='gt', window=1): |
Andre Puschmann | 7c1c8d6 | 2020-06-18 10:05:31 +0200 | [diff] [blame] | 409 | # copy back metrics if we have not already done so |
| 410 | self.scp_back_metrics(self) |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 411 | metrics = srsUEMetrics(self.metrics_file) |
Andre Puschmann | 2cfa4a3 | 2020-05-22 16:15:25 +0200 | [diff] [blame] | 412 | return metrics.verify(value, operation, metric, criterion, window) |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 413 | |
Pau Espin Pedrol | 620d2ee | 2020-05-11 11:41:47 +0200 | [diff] [blame] | 414 | numpy = None |
| 415 | |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 416 | class srsUEMetrics(log.Origin): |
| 417 | |
Andre Puschmann | f8c99a8 | 2020-06-30 18:08:41 +0200 | [diff] [blame] | 418 | VALID_OPERATIONS = ['avg', 'sum', 'max_rolling_avg', 'min_rolling_avg'] |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 419 | VALID_CRITERION = ['eq','gt','lt'] |
| 420 | CRITERION_TO_SYM = { 'eq' : '==', 'gt' : '>', 'lt' : '<' } |
| 421 | CRYTERION_TO_SYM_OPPOSITE = { 'eq' : '!=', 'gt' : '<=', 'lt' : '>=' } |
| 422 | |
| 423 | |
| 424 | def __init__(self, metrics_file): |
| 425 | super().__init__(log.C_RUN, 'srsue_metrics') |
| 426 | self.raw_data = None |
| 427 | self.metrics_file = metrics_file |
Pau Espin Pedrol | 620d2ee | 2020-05-11 11:41:47 +0200 | [diff] [blame] | 428 | global numpy |
| 429 | if numpy is None: |
| 430 | import numpy as numpy_module |
| 431 | numpy = numpy_module |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 432 | # read CSV, guessing data type with first row being the legend |
| 433 | try: |
| 434 | self.raw_data = numpy.genfromtxt(self.metrics_file, names=True, delimiter=';', dtype=None) |
| 435 | except (ValueError, IndexError, IOError) as error: |
| 436 | self.err("Error parsing metrics CSV file %s" % self.metrics_file) |
| 437 | raise error |
| 438 | |
Andre Puschmann | 1a96ecd | 2020-05-25 22:36:58 +0200 | [diff] [blame] | 439 | def verify(self, value, operation='avg', metric_str='dl_brate', criterion='gt', window=1): |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 440 | if operation not in self.VALID_OPERATIONS: |
| 441 | raise log.Error('Unknown operation %s not in %r' % (operation, self.VALID_OPERATIONS)) |
| 442 | if criterion not in self.VALID_CRITERION: |
| 443 | raise log.Error('Unknown operation %s not in %r' % (operation, self.VALID_CRITERION)) |
| 444 | # check if given metric exists in data |
Andre Puschmann | 1a96ecd | 2020-05-25 22:36:58 +0200 | [diff] [blame] | 445 | sel_data = numpy.array([]) |
| 446 | metrics_list = metric_str.split('+') # allow addition operator for columns |
| 447 | for metric in metrics_list: |
| 448 | try: |
| 449 | vec = numpy.array(self.raw_data[metric]) |
| 450 | except ValueError as err: |
| 451 | print('metric %s not available' % metric) |
| 452 | raise err |
| 453 | if sel_data.size == 0: |
| 454 | # Initialize with dimension of first metric vector |
| 455 | sel_data = vec |
| 456 | else: |
| 457 | # Sum them up assuming same array dimension |
| 458 | sel_data += vec |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 459 | |
Andre Puschmann | eb7ced1 | 2020-05-26 23:00:10 +0200 | [diff] [blame] | 460 | # Sum up all component carriers for rate metrics |
| 461 | if metric_str.find('brate'): |
| 462 | # Determine number of component carriers |
| 463 | num_cc = numpy.amax(numpy.array(self.raw_data['cc'])) + 1 # account for zero index |
| 464 | tmp_values = sel_data |
| 465 | sel_data = numpy.array(tmp_values[::num_cc]) # first carrier, every num_cc'th item in list |
| 466 | for cc in range(1, num_cc): |
| 467 | sel_data += numpy.array(tmp_values[cc::num_cc]) # all other carriers, start at cc index |
| 468 | |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 469 | if operation == 'avg': |
| 470 | result = numpy.average(sel_data) |
| 471 | elif operation == 'sum': |
| 472 | result = numpy.sum(sel_data) |
Andre Puschmann | 2cfa4a3 | 2020-05-22 16:15:25 +0200 | [diff] [blame] | 473 | elif operation == 'max_rolling_avg': |
| 474 | # calculate rolling average over window and take maximum value |
| 475 | result = numpy.amax(numpy.convolve(sel_data, numpy.ones((window,))/window, mode='valid')) |
Andre Puschmann | f8c99a8 | 2020-06-30 18:08:41 +0200 | [diff] [blame] | 476 | elif operation == 'min_rolling_avg': |
Andre Puschmann | 9bcbb9a | 2020-08-27 15:34:04 +0200 | [diff] [blame] | 477 | # trim leading zeros to avoid false negative when UE attach takes longer |
| 478 | sel_data = numpy.trim_zeros(sel_data, 'f') |
Andre Puschmann | f8c99a8 | 2020-06-30 18:08:41 +0200 | [diff] [blame] | 479 | # calculate rolling average over window and take minimum value |
| 480 | result = numpy.amin(numpy.convolve(sel_data, numpy.ones((window,))/window, mode='valid')) |
Andre Puschmann | 2cfa4a3 | 2020-05-22 16:15:25 +0200 | [diff] [blame] | 481 | |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 482 | self.dbg(result=result, value=value) |
| 483 | |
| 484 | success = False |
| 485 | if criterion == 'eq' and result == value or \ |
| 486 | criterion == 'gt' and result > value or \ |
| 487 | criterion == 'lt' and result < value: |
| 488 | success = True |
| 489 | |
| 490 | # Convert bitrate in Mbit/s: |
Andre Puschmann | 1a96ecd | 2020-05-25 22:36:58 +0200 | [diff] [blame] | 491 | if metric_str.find('brate') > 0: |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 492 | result /= 1e6 |
| 493 | value /= 1e6 |
| 494 | mbit_str = ' Mbit/s' |
| 495 | else: |
| 496 | mbit_str = '' |
| 497 | |
| 498 | if not success: |
| 499 | result_msg = "{:.2f}{} {} {:.2f}{}".format(result, mbit_str, self.CRYTERION_TO_SYM_OPPOSITE[criterion], value, mbit_str) |
| 500 | raise log.Error(result_msg) |
| 501 | result_msg = "{:.2f}{} {} {:.2f}{}".format(result, mbit_str, self.CRITERION_TO_SYM[criterion], value, mbit_str) |
| 502 | # TODO: overwrite test system-out with this text. |
| 503 | return result_msg |
| 504 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 505 | # vim: expandtab tabstop=4 shiftwidth=4 |