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 |
| 25 | from .ms import MS |
| 26 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 27 | def rf_type_valid(rf_type_str): |
| 28 | return rf_type_str in ('zmq', 'UHD', 'soapy', 'bladeRF') |
| 29 | |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame^] | 30 | #reference: srsLTE.git srslte_symbol_sz() |
| 31 | def num_prb2symbol_sz(num_prb): |
| 32 | if num_prb <= 6: |
| 33 | return 128 |
| 34 | if num_prb <= 15: |
| 35 | return 256 |
| 36 | if num_prb <= 25: |
| 37 | return 384 |
| 38 | if num_prb <= 50: |
| 39 | return 768 |
| 40 | if num_prb <= 75: |
| 41 | return 1024 |
| 42 | if num_prb <= 110: |
| 43 | return 1536 |
| 44 | raise log.Error('invalid num_prb %r', num_prb) |
| 45 | |
| 46 | def num_prb2base_srate(num_prb): |
| 47 | return num_prb2symbol_sz(num_prb) * 15 * 1000 |
| 48 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 49 | class srsUE(MS): |
| 50 | |
| 51 | REMOTE_DIR = '/osmo-gsm-tester-srsue' |
| 52 | BINFILE = 'srsue' |
| 53 | CFGFILE = 'srsue.conf' |
| 54 | PCAPFILE = 'srsue.pcap' |
| 55 | LOGFILE = 'srsue.log' |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 56 | METRICSFILE = 'srsue_metrics.csv' |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 57 | |
| 58 | def __init__(self, suite_run, conf): |
| 59 | self._addr = conf.get('addr', None) |
| 60 | if self._addr is None: |
| 61 | raise log.Error('addr not set') |
| 62 | super().__init__('srsue_%s' % self._addr, conf) |
| 63 | self.enb = None |
| 64 | self.run_dir = None |
| 65 | self.config_file = None |
| 66 | self.log_file = None |
| 67 | self.pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 68 | self.metrics_file = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 69 | self.process = None |
| 70 | self.rem_host = None |
| 71 | self.remote_config_file = None |
| 72 | self.remote_log_file = None |
| 73 | self.remote_pcap_file = None |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 74 | self.remote_metrics_file = None |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 75 | self.suite_run = suite_run |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 76 | self.remote_user = conf.get('remote_user', None) |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 77 | if not rf_type_valid(conf.get('rf_dev_type', None)): |
| 78 | 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] | 79 | |
| 80 | def cleanup(self): |
| 81 | if self.process is None: |
| 82 | return |
| 83 | if self.setup_runs_locally(): |
| 84 | return |
| 85 | # copy back files (may not exist, for instance if there was an early error of process): |
| 86 | try: |
| 87 | self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file) |
| 88 | except Exception as e: |
| 89 | self.log(repr(e)) |
| 90 | try: |
| 91 | self.rem_host.scpfrom('scp-back-pcap', self.remote_pcap_file, self.pcap_file) |
| 92 | except Exception as e: |
| 93 | self.log(repr(e)) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 94 | try: |
| 95 | self.rem_host.scpfrom('scp-back-metrics', self.remote_metrics_file, self.metrics_file) |
| 96 | except Exception as e: |
| 97 | self.log(repr(e)) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 98 | |
| 99 | def setup_runs_locally(self): |
| 100 | return self.remote_user is None |
| 101 | |
| 102 | def netns(self): |
| 103 | return "srsue1" |
| 104 | |
| 105 | def connect(self, enb): |
| 106 | self.log('Starting srsue') |
| 107 | self.enb = enb |
| 108 | self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name())) |
| 109 | self.configure() |
| 110 | if self.setup_runs_locally(): |
| 111 | self.start_locally() |
| 112 | else: |
| 113 | self.start_remotely() |
| 114 | |
| 115 | def start_remotely(self): |
| 116 | self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte'))) |
| 117 | lib = self.inst.child('lib') |
| 118 | if not os.path.isdir(lib): |
| 119 | raise log.Error('No lib/ in', self.inst) |
| 120 | if not self.inst.isfile('bin', srsUE.BINFILE): |
| 121 | raise log.Error('No %s binary in' % srsUE.BINFILE, self.inst) |
| 122 | |
| 123 | self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr) |
| 124 | remote_prefix_dir = util.Dir(srsUE.REMOTE_DIR) |
| 125 | remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst)))) |
| 126 | remote_run_dir = util.Dir(remote_prefix_dir.child(srsUE.BINFILE)) |
| 127 | self.remote_config_file = remote_run_dir.child(srsUE.CFGFILE) |
| 128 | self.remote_log_file = remote_run_dir.child(srsUE.LOGFILE) |
| 129 | self.remote_pcap_file = remote_run_dir.child(srsUE.PCAPFILE) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 130 | self.remote_metrics_file = remote_run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 131 | |
| 132 | self.rem_host.recreate_remote_dir(remote_inst) |
| 133 | self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir) |
| 134 | self.rem_host.create_remote_dir(remote_run_dir) |
| 135 | self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file) |
| 136 | |
| 137 | remote_lib = remote_inst.child('lib') |
| 138 | remote_binary = remote_inst.child('bin', srsUE.BINFILE) |
| 139 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 140 | self.log('Setting RPATH for srsue') |
| 141 | # srsue binary needs patchelf >= 0.9+52 to avoid failing during patch. OS#4389, patchelf-GH#192. |
| 142 | self.rem_host.set_remote_env({'PATCHELF_BIN': '/opt/bin/patchelf-v0.10' }) |
| 143 | self.rem_host.change_elf_rpath(remote_binary, remote_lib) |
| 144 | |
| 145 | # srsue requires CAP_SYS_ADMIN to cjump to net network namespace: netns(CLONE_NEWNET): |
| 146 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 147 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 148 | self.rem_host.setcap_netsys_admin(remote_binary) |
| 149 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 150 | self.log('Creating netns %s' % self.netns()) |
| 151 | self.rem_host.create_netns(self.netns()) |
| 152 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 153 | #'strace', '-ff', |
| 154 | args = (remote_binary, self.remote_config_file, |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 155 | '--phy.nof_phy_threads=1', |
| 156 | '--gw.netns=' + self.netns(), |
| 157 | '--log.filename=' + 'stdout', #self.remote_log_file, |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 158 | '--pcap.filename=' + self.remote_pcap_file, |
| 159 | '--general.metrics_csv_filename=' + self.remote_metrics_file) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 160 | |
| 161 | self.process = self.rem_host.RemoteProcessFixIgnoreSIGHUP(srsUE.BINFILE, util.Dir(srsUE.REMOTE_DIR), args) |
| 162 | #self.process = self.rem_host.RemoteProcessFixIgnoreSIGHUP(srsUE.BINFILE, remote_run_dir, args, remote_lib) |
| 163 | self.suite_run.remember_to_stop(self.process) |
| 164 | self.process.launch() |
| 165 | |
| 166 | def start_locally(self): |
| 167 | inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte'))) |
| 168 | |
| 169 | binary = inst.child('bin', BINFILE) |
| 170 | if not os.path.isfile(binary): |
| 171 | raise log.Error('Binary missing:', binary) |
| 172 | lib = inst.child('lib') |
| 173 | if not os.path.isdir(lib): |
| 174 | raise log.Error('No lib/ in', inst) |
| 175 | |
| 176 | env = {} |
| 177 | |
| 178 | # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead. |
| 179 | self.log('Setting RPATH for srsue') |
| 180 | util.change_elf_rpath(binary, util.prepend_library_path(lib), self.run_dir.new_dir('patchelf')) |
| 181 | |
| 182 | # srsue requires CAP_SYS_ADMIN to cjump to net network namespace: netns(CLONE_NEWNET): |
| 183 | # srsue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF): |
| 184 | self.log('Applying CAP_SYS_ADMIN+CAP_NET_ADMIN capability to srsue') |
| 185 | util.setcap_netsys_admin(binary, self.run_dir.new_dir('setcap_netsys_admin')) |
| 186 | |
Pau Espin Pedrol | 69b2cf3 | 2020-02-24 10:58:59 +0100 | [diff] [blame] | 187 | self.log('Creating netns %s' % self.netns()) |
| 188 | util.create_netns(self.netns(), self.run_dir.new_dir('create_netns')) |
| 189 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 190 | args = (binary, os.path.abspath(self.config_file), |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 191 | '--phy.nof_phy_threads=1', |
| 192 | '--gw.netns=' + self.netns(), |
| 193 | '--log.filename=' + self.log_file, |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 194 | '--pcap.filename=' + self.pcap_file, |
| 195 | '--general.metrics_csv_filename=' + self.metrics_file) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 196 | |
| 197 | self.dbg(run_dir=self.run_dir, binary=binary, env=env) |
| 198 | self.process = process.Process(self.name(), self.run_dir, args, env=env) |
| 199 | self.suite_run.remember_to_stop(self.process) |
| 200 | self.process.launch() |
| 201 | |
| 202 | def configure(self): |
| 203 | self.config_file = self.run_dir.new_file(srsUE.CFGFILE) |
| 204 | self.log_file = self.run_dir.child(srsUE.LOGFILE) |
| 205 | self.pcap_file = self.run_dir.new_file(srsUE.PCAPFILE) |
Pau Espin Pedrol | a031995 | 2020-03-02 11:06:51 +0100 | [diff] [blame] | 206 | self.metrics_file = self.run_dir.child(srsUE.METRICSFILE) |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 207 | self.dbg(config_file=self.config_file) |
| 208 | |
| 209 | values = dict(ue=config.get_defaults('srsue')) |
| 210 | config.overlay(values, self.suite_run.config()) |
| 211 | config.overlay(values, dict(ue=self._conf)) |
| 212 | |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 213 | # We need to set some specific variables programatically here to match IP addresses: |
| 214 | if self._conf.get('rf_dev_type') == 'zmq': |
Pau Espin Pedrol | 2aeadeb | 2020-03-02 11:50:23 +0100 | [diff] [blame^] | 215 | base_srate = num_prb2base_srate(self.enb.num_prb()) |
| 216 | config.overlay(values, dict(ue=dict(rf_dev_args='tx_port=tcp://' + self.addr() |
| 217 | +':2001,rx_port=tcp://' + self.enb.addr() |
| 218 | +':2000,id=ue,base_srate='+ str(base_srate) |
| 219 | ))) |
Pau Espin Pedrol | a9a2fe2 | 2020-02-13 19:29:55 +0100 | [diff] [blame] | 220 | |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 221 | self.dbg('SRSUE CONFIG:\n' + pprint.pformat(values)) |
| 222 | |
| 223 | with open(self.config_file, 'w') as f: |
| 224 | r = template.render(srsUE.CFGFILE, values) |
| 225 | self.dbg(r) |
| 226 | f.write(r) |
| 227 | |
| 228 | def is_connected(self, mcc_mnc=None): |
| 229 | return 'Network attach successful.' in (self.process.get_stdout() or '') |
| 230 | |
| 231 | def is_attached(self): |
| 232 | return self.is_connected() |
| 233 | |
| 234 | def running(self): |
| 235 | return not self.process.terminated() |
| 236 | |
| 237 | def addr(self): |
| 238 | return self._addr |
| 239 | |
| 240 | def run_node(self): |
Pau Espin Pedrol | c8b0f93 | 2020-02-11 17:45:26 +0100 | [diff] [blame] | 241 | return RunNode(RunNode.T_REM_SSH, self._addr, self.remote_user, self._addr) |
| 242 | |
| 243 | def run_netns_wait(self, name, popen_args): |
| 244 | if self.setup_runs_locally(): |
| 245 | proc = process.NetNSProcess(name, self.run_dir.new_dir(name), self.netns(), popen_args, env={}) |
| 246 | else: |
| 247 | proc = self.rem_host.RemoteNetNSProcess(name, self.netns(), popen_args, env={}) |
| 248 | proc.launch_sync() |
| 249 | |
| 250 | # vim: expandtab tabstop=4 shiftwidth=4 |