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