Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [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 | |
Pau Espin Pedrol | e1a58bd | 2020-04-10 20:46:07 +0200 | [diff] [blame] | 23 | from ..core import log, util, config, template, process, remote |
| 24 | from ..core.event_loop import MainLoop |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 25 | from .run_node import RunNode |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 26 | from .ms import MS |
| 27 | |
| 28 | def rf_type_valid(rf_type_str): |
| 29 | return rf_type_str in ('uhd', 'zmq') |
| 30 | |
| 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 | |
Andre Puschmann | d97ab42 | 2020-04-07 18:38:21 +0200 | [diff] [blame] | 50 | def num_prb2bandwidth(num_prb): |
| 51 | if num_prb <= 6: |
| 52 | return 1.4 |
| 53 | if num_prb <= 15: |
| 54 | return 3 |
| 55 | if num_prb <= 25: |
| 56 | return 5 |
| 57 | if num_prb <= 50: |
| 58 | return 10 |
| 59 | if num_prb <= 75: |
| 60 | return 15 |
| 61 | if num_prb <= 110: |
| 62 | return 20 |
| 63 | raise log.Error('invalid num_prb %r', num_prb) |
| 64 | |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 65 | class AmarisoftUE(MS): |
| 66 | |
| 67 | REMOTE_DIR = '/osmo-gsm-tester-amarisoftue' |
| 68 | BINFILE = 'lteue' |
| 69 | CFGFILE = 'amarisoft_lteue.cfg' |
| 70 | CFGFILE_RF = 'amarisoft_rf_driver.cfg' |
| 71 | LOGFILE = 'lteue.log' |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 72 | IFUPFILE = 'ue-ifup' |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 73 | |
| 74 | def __init__(self, suite_run, conf): |
| 75 | self._addr = conf.get('addr', None) |
| 76 | if self._addr is None: |
| 77 | raise log.Error('addr not set') |
| 78 | super().__init__('amarisoftue_%s' % self._addr, conf) |
| 79 | self.enb = None |
| 80 | self.run_dir = None |
| 81 | self.inst = None |
| 82 | self._bin_prefix = None |
| 83 | self.config_file = None |
| 84 | self.config_rf_file = None |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 85 | self.ifup_file = None |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 86 | self.log_file = None |
| 87 | self.process = None |
| 88 | self.rem_host = None |
| 89 | self.remote_inst = None |
| 90 | self.remote_config_file = None |
| 91 | self.remote_config_rf_file = None |
| 92 | self.remote_log_file = None |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 93 | self.remote_ifup_file = None |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 94 | self.suite_run = suite_run |
| 95 | self.remote_user = conf.get('remote_user', None) |
| 96 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 97 | raise log.Error('Invalid rf_dev_type=%s' % conf.get('rf_dev_type', None)) |
| 98 | |
| 99 | def bin_prefix(self): |
| 100 | if self._bin_prefix is None: |
| 101 | self._bin_prefix = os.getenv('AMARISOFT_PATH_UE', None) |
| 102 | if self._bin_prefix == None: |
| 103 | self._bin_prefix = self.suite_run.trial.get_inst('amarisoftue') |
| 104 | return self._bin_prefix |
| 105 | |
| 106 | def cleanup(self): |
| 107 | if self.process is None: |
| 108 | return |
| 109 | if self.setup_runs_locally(): |
| 110 | return |
| 111 | # copy back files (may not exist, for instance if there was an early error of process): |
| 112 | try: |
| 113 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 114 | except Exception as e: |
| 115 | self.log(repr(e)) |
| 116 | |
| 117 | def setup_runs_locally(self): |
| 118 | return self.remote_user is None |
| 119 | |
| 120 | def netns(self): |
| 121 | return "amarisoftue1" |
| 122 | |
| 123 | def stop(self): |
| 124 | self.suite_run.stop_process(self.process) |
| 125 | |
| 126 | def connect(self, enb): |
| 127 | self.log('Starting amarisoftue') |
| 128 | self.enb = enb |
| 129 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
| 130 | self.configure() |
| 131 | if self.setup_runs_locally(): |
| 132 | self.start_locally() |
| 133 | else: |
| 134 | self.start_remotely() |
| 135 | |
| 136 | # send t+Enter to enable console trace |
| 137 | self.dbg('Enabling console trace') |
| 138 | self.process.stdin_write('t\n') |
| 139 | |
| 140 | def start_remotely(self): |
| 141 | remote_binary = self.remote_inst.child('', AmarisoftUE.BINFILE) |
| 142 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 143 | self.log('Setting RPATH for ltetue') |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 144 | # patchelf >= 0.10 is required to support passing several files at once: |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 145 | self.rem_host.set_remote_env({'PATCHELF_BIN': '/opt/bin/patchelf-v0.10' }) |
| 146 | self.rem_host.change_elf_rpath(remote_binary, str(self.remote_inst)) |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 147 | # We also need to patch the arch-optimized binaries that lteue() will exec() into: |
| 148 | self.rem_host.change_elf_rpath(self.remote_inst.child('', 'lteue-*'), str(self.remote_inst)) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 149 | |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 150 | # lteue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 151 | self.log('Applying CAP_NET_ADMIN capability to ltetue') |
| 152 | self.rem_host.setcap_net_admin(remote_binary) |
| 153 | self.rem_host.setcap_net_admin(self.remote_inst.child('', 'lteue-*')) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 154 | |
| 155 | args = (remote_binary, self.remote_config_file) |
| 156 | self.process = self.rem_host.RemoteProcess(AmarisoftUE.BINFILE, args) |
| 157 | self.suite_run.remember_to_stop(self.process) |
| 158 | self.process.launch() |
| 159 | |
| 160 | def start_locally(self): |
| 161 | binary = self.inst.child('', AmarisoftUE.BINFILE) |
| 162 | env = {} |
| 163 | |
| 164 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 165 | self.log('Setting RPATH for lteue') |
| 166 | util.change_elf_rpath(binary, util.prepend_library_path(self.inst), self.run_dir.new_dir('patchelf')) |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 167 | # We also need to patch the arch-optimized binaries that lteue() will exec() into: |
| 168 | util.change_elf_rpath(self.inst.child('', 'lteue-*'), util.prepend_library_path(self.inst), self.run_dir.new_dir('patchelf2')) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 169 | |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 170 | # lteue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 171 | self.log('Applying CAP_NET_ADMIN capability to lteue') |
| 172 | util.setcap_net_admin(binary, self.run_dir.new_dir('setcap_net_admin')) |
| 173 | util.setcap_net_admin(self.inst.child('', 'lteue-*'), self.run_dir.new_dir('setcap_net_admin2')) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 174 | |
| 175 | args = (binary, os.path.abspath(self.config_file)) |
| 176 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 177 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 178 | self.suite_run.remember_to_stop(self.process) |
| 179 | self.process.launch() |
| 180 | |
| 181 | def gen_conf_file(self, path, filename, values): |
| 182 | self.dbg('AmarisoftUE ' + filename + ':\n' + pprint.pformat(values)) |
| 183 | with open(path, 'w') as f: |
| 184 | r = template.render(filename, values) |
| 185 | self.dbg(r) |
| 186 | f.write(r) |
| 187 | |
| 188 | def configure(self): |
| 189 | self.inst = util.Dir(os.path.abspath(self.bin_prefix())) |
| 190 | if not self.inst.isfile('', AmarisoftUE.BINFILE): |
| 191 | raise log.Error('No %s binary in' % AmarisoftUE.BINFILE, self.inst) |
| 192 | |
| 193 | self.config_file = self.run_dir.child(AmarisoftUE.CFGFILE) |
| 194 | self.config_rf_file = self.run_dir.child(AmarisoftUE.CFGFILE_RF) |
| 195 | self.log_file = self.run_dir.child(AmarisoftUE.LOGFILE) |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 196 | self.ifup_file = self.run_dir.new_file(AmarisoftUE.IFUPFILE) |
| 197 | os.chmod(self.ifup_file, 0o744) # add execution permission |
| 198 | with open(self.ifup_file, 'w') as f: |
| 199 | r = '''#!/bin/sh |
| 200 | set -x -e |
| 201 | ue_id="$1" # UE ID |
| 202 | pdn_id="$2" # PDN unique id (start from 0) |
| 203 | ifname="$3" # Interface name |
| 204 | ipv4_addr="$4" # IPv4 address |
| 205 | ipv4_dns="$5" # IPv4 DNS |
| 206 | ipv6_local_addr="$6" # IPv6 local address |
| 207 | ipv6_dns="$7" # IPv6 DNS |
| 208 | old_link_local="" |
| 209 | # script + sudoers file available in osmo-gsm-tester.git/utils/{bin,sudoers.d} |
| 210 | sudo /usr/local/bin/osmo-gsm-tester_netns_setup.sh "%s" "$ifname" "$ipv4_addr" |
| 211 | echo "${ue_id}: netns %s configured" |
| 212 | ''' % (self.netns(), self.netns()) |
| 213 | f.write(r) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 214 | |
| 215 | if not self.setup_runs_locally(): |
| 216 | self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr) |
| 217 | remote_prefix_dir = util.Dir(AmarisoftUE.REMOTE_DIR) |
| 218 | self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 219 | remote_run_dir = util.Dir(remote_prefix_dir.child(AmarisoftUE.BINFILE)) |
| 220 | |
| 221 | self.remote_config_file = remote_run_dir.child(AmarisoftUE.CFGFILE) |
| 222 | self.remote_config_rf_file = remote_run_dir.child(AmarisoftUE.CFGFILE_RF) |
| 223 | self.remote_log_file = remote_run_dir.child(AmarisoftUE.LOGFILE) |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 224 | self.remote_ifup_file = remote_run_dir.child(AmarisoftUE.IFUPFILE) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 225 | |
| 226 | values = dict(ue=config.get_defaults('amarisoft')) |
| 227 | config.overlay(values, dict(ue=config.get_defaults('amarisoftue'))) |
| 228 | config.overlay(values, dict(ue=self.suite_run.config().get('amarisoft', {}))) |
| 229 | config.overlay(values, dict(ue=self.suite_run.config().get('modem', {}))) |
| 230 | config.overlay(values, dict(ue=self._conf)) |
| 231 | config.overlay(values, dict(ue=dict(num_antennas = self.enb.num_ports()))) |
| 232 | |
| 233 | logfile = self.log_file if self.setup_runs_locally() else self.remote_log_file |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 234 | ifupfile = self.ifup_file if self.setup_runs_locally() else self.remote_ifup_file |
| 235 | config.overlay(values, dict(ue=dict(log_filename=logfile, |
| 236 | ifup_filename=ifupfile))) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 237 | |
| 238 | # We need to set some specific variables programatically here to match IP addresses: |
| 239 | if self._conf.get('rf_dev_type') == 'zmq': |
| 240 | base_srate = num_prb2base_srate(self.enb.num_prb()) |
| 241 | rf_dev_args = 'tx_port0=tcp://' + self.addr() + ':2001' \ |
| 242 | + ',tx_port1=tcp://' + self.addr() + ':2003' \ |
| 243 | + ',rx_port0=tcp://' + self.enb.addr() + ':2000' \ |
| 244 | + ',rx_port1=tcp://' + self.enb.addr() + ':2002' \ |
| 245 | + ',tx_freq=2510e6,rx_freq=2630e6,tx_freq2=2530e6,rx_freq2=2650e6' \ |
| 246 | + ',id=ue,base_srate='+ str(base_srate) |
| 247 | config.overlay(values, dict(ue=dict(sample_rate = base_srate / (1000*1000), |
| 248 | rf_dev_args = rf_dev_args))) |
| 249 | |
Andre Puschmann | d97ab42 | 2020-04-07 18:38:21 +0200 | [diff] [blame] | 250 | # The UHD rf driver seems to require the bandwidth configuration |
| 251 | if self._conf.get('rf_dev_type') == 'uhd': |
| 252 | bandwidth = num_prb2bandwidth(self.enb.num_prb()) |
| 253 | config.overlay(values, dict(ue=dict(bandwidth = bandwidth))) |
| 254 | |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 255 | # Set UHD frame size as a function of the cell bandwidth on B2XX |
Andre Puschmann | d97ab42 | 2020-04-07 18:38:21 +0200 | [diff] [blame] | 256 | if self._conf.get('rf_dev_type') == 'uhd' and values['ue'].get('rf_dev_args', None) is not None: |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 257 | if 'b200' in values['ue'].get('rf_dev_args'): |
| 258 | rf_dev_args = values['ue'].get('rf_dev_args', '') |
| 259 | rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else '' |
| 260 | |
| 261 | if self.enb.num_prb() < 25: |
| 262 | rf_dev_args += 'send_frame_size=512,recv_frame_size=512' |
| 263 | elif self.enb.num_prb() == 25: |
| 264 | rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024' |
| 265 | elif self.enb.num_prb() > 50: |
| 266 | rf_dev_args += 'num_recv_frames=64,num_send_frames=64' |
| 267 | |
| 268 | # For 15 and 20 MHz, further reduce over the wire format to sc12 |
| 269 | if self.enb.num_prb() >= 75: |
| 270 | rf_dev_args += ',otw_format=sc12' |
| 271 | |
| 272 | config.overlay(values, dict(ue=dict(rf_dev_args=rf_dev_args))) |
| 273 | |
| 274 | # rf driver is shared between amarisoft enb and ue, so it has a |
| 275 | # different cfg namespace 'trx'. Copy needed values over there: |
| 276 | config.overlay(values, dict(trx=dict(rf_dev_type=values['ue'].get('rf_dev_type', None), |
| 277 | rf_dev_args=values['ue'].get('rf_dev_args', None)))) |
| 278 | |
| 279 | self.gen_conf_file(self.config_file, AmarisoftUE.CFGFILE, values) |
| 280 | self.gen_conf_file(self.config_rf_file, AmarisoftUE.CFGFILE_RF, values) |
| 281 | |
| 282 | if not self.setup_runs_locally(): |
| 283 | self.rem_host.recreate_remote_dir(self.remote_inst) |
| 284 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 285 | self.rem_host.recreate_remote_dir(remote_run_dir) |
| 286 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 287 | self.rem_host.scp('scp-cfg-rf-to-remote', self.config_rf_file, self.remote_config_rf_file) |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 288 | self.rem_host.scp('scp-ifup-to-remote', self.ifup_file, self.remote_ifup_file) |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 289 | |
| 290 | def is_connected(self, mcc_mnc=None): |
Pau Espin Pedrol | 23e60e5 | 2020-04-08 15:16:50 +0200 | [diff] [blame] | 291 | # lteue doesn't call the ifup script until after it becomes attached, so |
| 292 | # simply look for our ifup script output at the end of it: |
| 293 | return 'netns %s configured' % (self.netns()) in (self.process.get_stdout() or '') |
Pau Espin Pedrol | 65beb8f | 2020-03-31 12:03:19 +0200 | [diff] [blame] | 294 | |
| 295 | def is_attached(self): |
| 296 | return self.is_connected() |
| 297 | |
| 298 | def running(self): |
| 299 | return not self.process.terminated() |
| 300 | |
| 301 | def addr(self): |
| 302 | return self._addr |
| 303 | |
| 304 | def run_node(self): |
| 305 | return RunNode(RunNode.T_REM_SSH, self._addr, self.remote_user, self._addr) |
| 306 | |
| 307 | def run_netns_wait(self, name, popen_args): |
| 308 | if self.setup_runs_locally(): |
| 309 | proc = process.NetNSProcess(name, self.run_dir.new_dir(name), self.netns(), popen_args, env={}) |
| 310 | else: |
| 311 | proc = self.rem_host.RemoteNetNSProcess(name, self.netns(), popen_args, env={}) |
| 312 | proc.launch_sync() |
| 313 | return proc |
| 314 | |
| 315 | def verify_metric(self, value, operation='avg', metric='dl_brate', criterion='gt'): |
| 316 | return 'metrics not yet implemented with Amarisoft UE' |
| 317 | |
| 318 | # vim: expandtab tabstop=4 shiftwidth=4 |