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 |
| 22 | |
| 23 | from . import log, util, config, template, process, remote |
| 24 | from .run_node import RunNode |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 25 | from .event_loop import MainLoop |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 26 | from .ms import MS |
| 27 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 28 | def rf_type_valid(rf_type_str): |
Pau Espin Pedrol | 12ae6d7 | 2020-04-01 14:12:10 +0200 | [diff] [blame] | 29 | return rf_type_str in ('zmq', 'uhd', 'soapy', 'bladerf') |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 30 | |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 31 | #reference: srsLTE.git srslte_symbol_sz() |
| 32 | def num_prb2symbol_sz(num_prb): |
| 33 | if num_prb <= 6: |
| 34 | return 128 |
| 35 | if num_prb <= 15: |
| 36 | return 256 |
| 37 | if num_prb <= 25: |
| 38 | return 384 |
| 39 | if num_prb <= 50: |
| 40 | return 768 |
| 41 | if num_prb <= 75: |
| 42 | return 1024 |
| 43 | if num_prb <= 110: |
| 44 | return 1536 |
| 45 | raise log.Error('invalid num_prb %r', num_prb) |
| 46 | |
| 47 | def num_prb2base_srate(num_prb): |
| 48 | return num_prb2symbol_sz(num_prb) * 15 * 1000 |
| 49 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 50 | class srsUE(MS): |
| 51 | |
| 52 | REMOTE_DIR = '/osmo-gsm-tester-srsue' |
| 53 | BINFILE = 'srsue' |
| 54 | CFGFILE = 'srsue.conf' |
| 55 | PCAPFILE = 'srsue.pcap' |
| 56 | LOGFILE = 'srsue.log' |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 57 | METRICSFILE = 'srsue_metrics.csv' |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 58 | |
| 59 | def __init__(self, suite_run, conf): |
| 60 | self._addr = conf.get('addr', None) |
| 61 | if self._addr is None: |
| 62 | raise log.Error('addr not set') |
| 63 | super().__init__('srsue_%s' % self._addr, conf) |
| 64 | self.enb = None |
| 65 | self.run_dir = None |
| 66 | self.config_file = None |
| 67 | self.log_file = None |
| 68 | self.pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 69 | self.metrics_file = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 70 | self.process = None |
| 71 | self.rem_host = None |
| 72 | self.remote_config_file = None |
| 73 | self.remote_log_file = None |
| 74 | self.remote_pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 75 | self.remote_metrics_file = None |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 76 | self.enable_pcap = False |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 77 | self.suite_run = suite_run |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 78 | self.remote_user = conf.get('remote_user', None) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 79 | self._additional_args = [] |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 80 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 81 | 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] | 82 | |
| 83 | def cleanup(self): |
| 84 | if self.process is None: |
| 85 | return |
| 86 | if self.setup_runs_locally(): |
| 87 | return |
Pau Espin Pedrol | 5b31cc3 | 2020-03-09 16:34:45 +0100 | [diff] [blame] | 88 | # When using zmq, srsUE is known to hang for a few seconds before |
| 89 | # exiting (3 seconds after alarm() watchdog kicks in). We hence need to |
| 90 | # wait to make sure the remote process terminated and the file was |
| 91 | # flushed, since cleanup() triggered means only the local ssh client was killed. |
| 92 | if self._conf and self._conf.get('rf_dev_type', '') == 'zmq': |
| 93 | MainLoop.sleep(self, 3) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 94 | # copy back files (may not exist, for instance if there was an early error of process): |
| 95 | try: |
| 96 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 97 | except Exception as e: |
| 98 | self.log(repr(e)) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 99 | if self.enable_pcap: |
| 100 | try: |
| 101 | self.rem_host.scpfrom('scp-back-pcap', self.remote_pcap_file, self.pcap_file) |
| 102 | except Exception as e: |
| 103 | self.log(repr(e)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 104 | |
| 105 | def setup_runs_locally(self): |
| 106 | return self.remote_user is None |
| 107 | |
| 108 | def netns(self): |
| 109 | return "srsue1" |
| 110 | |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 111 | def stop(self): |
| 112 | self.suite_run.stop_process(self.process) |
| 113 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 114 | def connect(self, enb): |
| 115 | self.log('Starting srsue') |
| 116 | self.enb = enb |
| 117 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
| 118 | self.configure() |
| 119 | if self.setup_runs_locally(): |
| 120 | self.start_locally() |
| 121 | else: |
| 122 | self.start_remotely() |
| 123 | |
Andre Puschmann | 2e8626f | 2020-03-21 21:18:39 +0100 | [diff] [blame] | 124 | # send t+Enter to enable console trace |
| 125 | self.dbg('Enabling console trace') |
| 126 | self.process.stdin_write('t\n') |
| 127 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 128 | def start_remotely(self): |
| 129 | self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte'))) |
| 130 | lib = self.inst.child('lib') |
| 131 | if not os.path.isdir(lib): |
| 132 | raise log.Error('No lib/ in', self.inst) |
| 133 | if not self.inst.isfile('bin', srsUE.BINFILE): |
| 134 | raise log.Error('No %s binary in' % srsUE.BINFILE, self.inst) |
| 135 | |
| 136 | self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr) |
| 137 | remote_prefix_dir = util.Dir(srsUE.REMOTE_DIR) |
| 138 | remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 139 | remote_run_dir = util.Dir(remote_prefix_dir.child(srsUE.BINFILE)) |
| 140 | self.remote_config_file = remote_run_dir.child(srsUE.CFGFILE) |
| 141 | self.remote_log_file = remote_run_dir.child(srsUE.LOGFILE) |
| 142 | self.remote_pcap_file = remote_run_dir.child(srsUE.PCAPFILE) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 143 | self.remote_metrics_file = remote_run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 144 | |
| 145 | self.rem_host.recreate_remote_dir(remote_inst) |
| 146 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 147 | self.rem_host.recreate_remote_dir(remote_run_dir) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 148 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 149 | |
| 150 | remote_lib = remote_inst.child('lib') |
| 151 | remote_binary = remote_inst.child('bin', srsUE.BINFILE) |
| 152 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 153 | self.log('Setting RPATH for srsue') |
| 154 | # srsue binary needs patchelf >= 0.9+52 to avoid failing during patch. OS#4389, patchelf-GH#192. |
| 155 | self.rem_host.set_remote_env({'PATCHELF_BIN': '/opt/bin/patchelf-v0.10' }) |
| 156 | self.rem_host.change_elf_rpath(remote_binary, remote_lib) |
| 157 | |
| 158 | # srsue requires CAP_SYS_ADMIN to cjump to net network namespace: netns(CLONE_NEWNET): |
| 159 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 160 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 161 | self.rem_host.setcap_netsys_admin(remote_binary) |
| 162 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 163 | self.log('Creating netns %s' % self.netns()) |
| 164 | self.rem_host.create_netns(self.netns()) |
| 165 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 166 | #'strace', '-ff', |
| 167 | args = (remote_binary, self.remote_config_file, |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 168 | '--gw.netns=' + self.netns(), |
Pau Espin Pedrol | 5b31cc3 | 2020-03-09 16:34:45 +0100 | [diff] [blame] | 169 | '--log.filename=' + self.remote_log_file, |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 170 | '--pcap.filename=' + self.remote_pcap_file, |
| 171 | '--general.metrics_csv_filename=' + self.remote_metrics_file) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 172 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 173 | |
Andre Puschmann | cfdcf89 | 2020-03-21 21:21:55 +0100 | [diff] [blame] | 174 | self.process = self.rem_host.RemoteProcess(srsUE.BINFILE, args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 175 | #self.process = self.rem_host.RemoteProcessFixIgnoreSIGHUP(srsUE.BINFILE, remote_run_dir, args, remote_lib) |
| 176 | self.suite_run.remember_to_stop(self.process) |
| 177 | self.process.launch() |
| 178 | |
| 179 | def start_locally(self): |
| 180 | inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte'))) |
| 181 | |
Pau Espin Pedrol | 9aa932f | 2020-03-31 11:46:04 +0200 | [diff] [blame] | 182 | binary = inst.child('bin', srsUE.BINFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 183 | if not os.path.isfile(binary): |
| 184 | raise log.Error('Binary missing:', binary) |
| 185 | lib = inst.child('lib') |
| 186 | if not os.path.isdir(lib): |
| 187 | raise log.Error('No lib/ in', inst) |
| 188 | |
| 189 | env = {} |
| 190 | |
| 191 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 192 | self.log('Setting RPATH for srsue') |
| 193 | util.change_elf_rpath(binary, util.prepend_library_path(lib), self.run_dir.new_dir('patchelf')) |
| 194 | |
| 195 | # srsue requires CAP_SYS_ADMIN to cjump to net network namespace: netns(CLONE_NEWNET): |
| 196 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 197 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 198 | util.setcap_netsys_admin(binary, self.run_dir.new_dir('setcap_netsys_admin')) |
| 199 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 200 | self.log('Creating netns %s' % self.netns()) |
| 201 | util.create_netns(self.netns(), self.run_dir.new_dir('create_netns')) |
| 202 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 203 | args = (binary, os.path.abspath(self.config_file), |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 204 | '--gw.netns=' + self.netns(), |
| 205 | '--log.filename=' + self.log_file, |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 206 | '--pcap.filename=' + self.pcap_file, |
| 207 | '--general.metrics_csv_filename=' + self.metrics_file) |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 208 | args += tuple(self._additional_args) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 209 | |
| 210 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 211 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 212 | self.suite_run.remember_to_stop(self.process) |
| 213 | self.process.launch() |
| 214 | |
| 215 | def configure(self): |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 216 | self.config_file = self.run_dir.child(srsUE.CFGFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 217 | self.log_file = self.run_dir.child(srsUE.LOGFILE) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 218 | self.pcap_file = self.run_dir.child(srsUE.PCAPFILE) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 219 | self.metrics_file = self.run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 220 | self.dbg(config_file=self.config_file) |
| 221 | |
| 222 | values = dict(ue=config.get_defaults('srsue')) |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 223 | config.overlay(values, dict(ue=self.suite_run.config().get('modem', {}))) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 224 | config.overlay(values, dict(ue=self._conf)) |
Pau Espin Pedrol | f796ad0 | 2020-03-09 15:50:57 +0100 | [diff] [blame] | 225 | config.overlay(values, dict(ue=dict(num_antennas = self.enb.num_ports()))) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 226 | |
Pau Espin Pedrol | 1e81b5a | 2020-03-16 12:42:17 +0100 | [diff] [blame] | 227 | # Convert parsed boolean string to Python boolean: |
| 228 | self.enable_pcap = util.str2bool(values['ue'].get('enable_pcap', 'false')) |
| 229 | config.overlay(values, dict(ue={'enable_pcap': self.enable_pcap})) |
| 230 | |
Pau Espin Pedrol | 76b2c2a | 2020-04-01 19:51:08 +0200 | [diff] [blame] | 231 | self._additional_args = values['ue'].get('additional_args', '').split() |
| 232 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 233 | # We need to set some specific variables programatically here to match IP addresses: |
| 234 | if self._conf.get('rf_dev_type') == 'zmq': |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 235 | base_srate = num_prb2base_srate(self.enb.num_prb()) |
Pau Espin Pedrol | f796ad0 | 2020-03-09 15:50:57 +0100 | [diff] [blame] | 236 | config.overlay(values, dict(ue=dict(rf_dev_args = 'tx_port=tcp://' + self.addr() + ':2001' \ |
| 237 | + ',tx_port2=tcp://' + self.addr() + ':2003' \ |
| 238 | + ',rx_port=tcp://' + self.enb.addr() + ':2000' \ |
| 239 | + ',rx_port2=tcp://' + self.enb.addr() + ':2002' \ |
Andre Puschmann | 3ffea80 | 2020-03-24 12:09:25 +0100 | [diff] [blame] | 240 | + ',tx_freq=2510e6,rx_freq=2630e6,tx_freq2=2530e6,rx_freq2=2650e6' \ |
Pau Espin Pedrol | f796ad0 | 2020-03-09 15:50:57 +0100 | [diff] [blame] | 241 | + ',id=ue,base_srate='+ str(base_srate) |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame] | 242 | ))) |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 243 | |
Andre Puschmann | 7225d52 | 2020-03-26 20:54:45 +0100 | [diff] [blame] | 244 | # 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] | 245 | 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] | 246 | if 'b200' in values['ue'].get('rf_dev_args'): |
| 247 | rf_dev_args = values['ue'].get('rf_dev_args', '') |
| 248 | rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else '' |
| 249 | |
| 250 | if self.enb.num_prb() < 25: |
| 251 | rf_dev_args += 'send_frame_size=512,recv_frame_size=512' |
| 252 | elif self.enb.num_prb() == 25: |
| 253 | rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024' |
| 254 | elif self.enb.num_prb() > 50: |
| 255 | rf_dev_args += 'num_recv_frames=64,num_send_frames=64' |
| 256 | |
| 257 | # For 15 and 20 MHz, further reduce over the wire format to sc12 |
| 258 | if self.enb.num_prb() >= 75: |
| 259 | rf_dev_args += ',otw_format=sc12' |
| 260 | |
| 261 | config.overlay(values, dict(ue=dict(rf_dev_args=rf_dev_args))) |
| 262 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 263 | self.dbg('SRSUE CONFIG:\n' + pprint.pformat(values)) |
| 264 | |
| 265 | with open(self.config_file, 'w') as f: |
| 266 | r = template.render(srsUE.CFGFILE, values) |
| 267 | self.dbg(r) |
| 268 | f.write(r) |
| 269 | |
| 270 | def is_connected(self, mcc_mnc=None): |
| 271 | return 'Network attach successful.' in (self.process.get_stdout() or '') |
| 272 | |
| 273 | def is_attached(self): |
| 274 | return self.is_connected() |
| 275 | |
| 276 | def running(self): |
| 277 | return not self.process.terminated() |
| 278 | |
| 279 | def addr(self): |
| 280 | return self._addr |
| 281 | |
| 282 | def run_node(self): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 283 | return RunNode(RunNode.T_REM_SSH, self._addr, self.remote_user, self._addr) |
| 284 | |
| 285 | def run_netns_wait(self, name, popen_args): |
| 286 | if self.setup_runs_locally(): |
| 287 | proc = process.NetNSProcess(name, self.run_dir.new_dir(name), self.netns(), popen_args, env={}) |
| 288 | else: |
| 289 | proc = self.rem_host.RemoteNetNSProcess(name, self.netns(), popen_args, env={}) |
| 290 | proc.launch_sync() |
Pau Espin Pedrol | 2bcd346 | 2020-03-05 18:30:37 +0100 | [diff] [blame] | 291 | return proc |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 292 | |
Pau Espin Pedrol | 151b08a | 2020-03-02 14:14:27 +0100 | [diff] [blame] | 293 | def verify_metric(self, value, operation='avg', metric='dl_brate', criterion='gt'): |
| 294 | # file is not properly flushed until the process has stopped. |
| 295 | if self.running(): |
| 296 | self.stop() |
| 297 | # metrics file is not flushed immediatelly by the OS during process |
| 298 | # tear down, we need to wait some extra time: |
| 299 | MainLoop.sleep(self, 2) |
| 300 | if not self.setup_runs_locally(): |
| 301 | try: |
| 302 | self.rem_host.scpfrom('scp-back-metrics', self.remote_metrics_file, self.metrics_file) |
| 303 | except Exception as e: |
| 304 | self.err('Failed copying back metrics file from remote host') |
| 305 | raise e |
| 306 | metrics = srsUEMetrics(self.metrics_file) |
| 307 | return metrics.verify(value, operation, metric, criterion) |
| 308 | |
| 309 | import numpy |
| 310 | |
| 311 | class srsUEMetrics(log.Origin): |
| 312 | |
| 313 | VALID_OPERATIONS = ['avg', 'sum'] |
| 314 | VALID_CRITERION = ['eq','gt','lt'] |
| 315 | CRITERION_TO_SYM = { 'eq' : '==', 'gt' : '>', 'lt' : '<' } |
| 316 | CRYTERION_TO_SYM_OPPOSITE = { 'eq' : '!=', 'gt' : '<=', 'lt' : '>=' } |
| 317 | |
| 318 | |
| 319 | def __init__(self, metrics_file): |
| 320 | super().__init__(log.C_RUN, 'srsue_metrics') |
| 321 | self.raw_data = None |
| 322 | self.metrics_file = metrics_file |
| 323 | # read CSV, guessing data type with first row being the legend |
| 324 | try: |
| 325 | self.raw_data = numpy.genfromtxt(self.metrics_file, names=True, delimiter=';', dtype=None) |
| 326 | except (ValueError, IndexError, IOError) as error: |
| 327 | self.err("Error parsing metrics CSV file %s" % self.metrics_file) |
| 328 | raise error |
| 329 | |
| 330 | def verify(self, value, operation='avg', metric='dl_brate', criterion='gt'): |
| 331 | if operation not in self.VALID_OPERATIONS: |
| 332 | raise log.Error('Unknown operation %s not in %r' % (operation, self.VALID_OPERATIONS)) |
| 333 | if criterion not in self.VALID_CRITERION: |
| 334 | raise log.Error('Unknown operation %s not in %r' % (operation, self.VALID_CRITERION)) |
| 335 | # check if given metric exists in data |
| 336 | try: |
| 337 | sel_data = self.raw_data[metric] |
| 338 | except ValueError as err: |
| 339 | print('metric %s not available' % metric) |
| 340 | raise err |
| 341 | |
| 342 | if operation == 'avg': |
| 343 | result = numpy.average(sel_data) |
| 344 | elif operation == 'sum': |
| 345 | result = numpy.sum(sel_data) |
| 346 | self.dbg(result=result, value=value) |
| 347 | |
| 348 | success = False |
| 349 | if criterion == 'eq' and result == value or \ |
| 350 | criterion == 'gt' and result > value or \ |
| 351 | criterion == 'lt' and result < value: |
| 352 | success = True |
| 353 | |
| 354 | # Convert bitrate in Mbit/s: |
| 355 | if metric.find('brate') > 0: |
| 356 | result /= 1e6 |
| 357 | value /= 1e6 |
| 358 | mbit_str = ' Mbit/s' |
| 359 | else: |
| 360 | mbit_str = '' |
| 361 | |
| 362 | if not success: |
| 363 | result_msg = "{:.2f}{} {} {:.2f}{}".format(result, mbit_str, self.CRYTERION_TO_SYM_OPPOSITE[criterion], value, mbit_str) |
| 364 | raise log.Error(result_msg) |
| 365 | result_msg = "{:.2f}{} {} {:.2f}{}".format(result, mbit_str, self.CRITERION_TO_SYM[criterion], value, mbit_str) |
| 366 | # TODO: overwrite test system-out with this text. |
| 367 | return result_msg |
| 368 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 369 | # vim: expandtab tabstop=4 shiftwidth=4 |