Move object classes used by tests into obj/ subdir
Change-Id: I0b2963cf00acd1f9036dca2e87aa3b87a0f8066d
diff --git a/src/osmo_gsm_tester/obj/ms_amarisoft.py b/src/osmo_gsm_tester/obj/ms_amarisoft.py
new file mode 100644
index 0000000..1b49b30
--- /dev/null
+++ b/src/osmo_gsm_tester/obj/ms_amarisoft.py
@@ -0,0 +1,318 @@
+# osmo_gsm_tester: specifics for running an SRS UE process
+#
+# Copyright (C) 2020 by sysmocom - s.f.m.c. GmbH
+#
+# Author: Pau Espin Pedrol <pespin@sysmocom.de>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import pprint
+
+from ..core import log, util, config, template, process, remote
+from ..core.event_loop import MainLoop
+from .run_node import RunNode
+from .ms import MS
+
+def rf_type_valid(rf_type_str):
+ return rf_type_str in ('uhd', 'zmq')
+
+#reference: srsLTE.git srslte_symbol_sz()
+def num_prb2symbol_sz(num_prb):
+ if num_prb <= 6:
+ return 128
+ if num_prb <= 15:
+ return 256
+ if num_prb <= 25:
+ return 384
+ if num_prb <= 50:
+ return 768
+ if num_prb <= 75:
+ return 1024
+ if num_prb <= 110:
+ return 1536
+ raise log.Error('invalid num_prb %r', num_prb)
+
+def num_prb2base_srate(num_prb):
+ return num_prb2symbol_sz(num_prb) * 15 * 1000
+
+def num_prb2bandwidth(num_prb):
+ if num_prb <= 6:
+ return 1.4
+ if num_prb <= 15:
+ return 3
+ if num_prb <= 25:
+ return 5
+ if num_prb <= 50:
+ return 10
+ if num_prb <= 75:
+ return 15
+ if num_prb <= 110:
+ return 20
+ raise log.Error('invalid num_prb %r', num_prb)
+
+class AmarisoftUE(MS):
+
+ REMOTE_DIR = '/osmo-gsm-tester-amarisoftue'
+ BINFILE = 'lteue'
+ CFGFILE = 'amarisoft_lteue.cfg'
+ CFGFILE_RF = 'amarisoft_rf_driver.cfg'
+ LOGFILE = 'lteue.log'
+ IFUPFILE = 'ue-ifup'
+
+ def __init__(self, suite_run, conf):
+ self._addr = conf.get('addr', None)
+ if self._addr is None:
+ raise log.Error('addr not set')
+ super().__init__('amarisoftue_%s' % self._addr, conf)
+ self.enb = None
+ self.run_dir = None
+ self.inst = None
+ self._bin_prefix = None
+ self.config_file = None
+ self.config_rf_file = None
+ self.ifup_file = None
+ self.log_file = None
+ self.process = None
+ self.rem_host = None
+ self.remote_inst = None
+ self.remote_config_file = None
+ self.remote_config_rf_file = None
+ self.remote_log_file = None
+ self.remote_ifup_file = None
+ self.suite_run = suite_run
+ self.remote_user = conf.get('remote_user', None)
+ if not rf_type_valid(conf.get('rf_dev_type', None)):
+ raise log.Error('Invalid rf_dev_type=%s' % conf.get('rf_dev_type', None))
+
+ def bin_prefix(self):
+ if self._bin_prefix is None:
+ self._bin_prefix = os.getenv('AMARISOFT_PATH_UE', None)
+ if self._bin_prefix == None:
+ self._bin_prefix = self.suite_run.trial.get_inst('amarisoftue')
+ return self._bin_prefix
+
+ def cleanup(self):
+ if self.process is None:
+ return
+ if self.setup_runs_locally():
+ return
+ # copy back files (may not exist, for instance if there was an early error of process):
+ try:
+ self.rem_host.scpfrom('scp-back-log', self.remote_log_file, self.log_file)
+ except Exception as e:
+ self.log(repr(e))
+
+ def setup_runs_locally(self):
+ return self.remote_user is None
+
+ def netns(self):
+ return "amarisoftue1"
+
+ def stop(self):
+ self.suite_run.stop_process(self.process)
+
+ def connect(self, enb):
+ self.log('Starting amarisoftue')
+ self.enb = enb
+ self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name()))
+ self.configure()
+ if self.setup_runs_locally():
+ self.start_locally()
+ else:
+ self.start_remotely()
+
+ # send t+Enter to enable console trace
+ self.dbg('Enabling console trace')
+ self.process.stdin_write('t\n')
+
+ def start_remotely(self):
+ remote_binary = self.remote_inst.child('', AmarisoftUE.BINFILE)
+ # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead.
+ self.log('Setting RPATH for ltetue')
+ # patchelf >= 0.10 is required to support passing several files at once:
+ self.rem_host.set_remote_env({'PATCHELF_BIN': '/opt/bin/patchelf-v0.10' })
+ self.rem_host.change_elf_rpath(remote_binary, str(self.remote_inst))
+ # We also need to patch the arch-optimized binaries that lteue() will exec() into:
+ self.rem_host.change_elf_rpath(self.remote_inst.child('', 'lteue-*'), str(self.remote_inst))
+
+ # lteue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF):
+ self.log('Applying CAP_NET_ADMIN capability to ltetue')
+ self.rem_host.setcap_net_admin(remote_binary)
+ self.rem_host.setcap_net_admin(self.remote_inst.child('', 'lteue-*'))
+
+ args = (remote_binary, self.remote_config_file)
+ self.process = self.rem_host.RemoteProcess(AmarisoftUE.BINFILE, args)
+ self.suite_run.remember_to_stop(self.process)
+ self.process.launch()
+
+ def start_locally(self):
+ binary = self.inst.child('', AmarisoftUE.BINFILE)
+ env = {}
+
+ # setting capabilities will later disable use of LD_LIBRARY_PATH from ELF loader -> modify RPATH instead.
+ self.log('Setting RPATH for lteue')
+ util.change_elf_rpath(binary, util.prepend_library_path(self.inst), self.run_dir.new_dir('patchelf'))
+ # We also need to patch the arch-optimized binaries that lteue() will exec() into:
+ util.change_elf_rpath(self.inst.child('', 'lteue-*'), util.prepend_library_path(self.inst), self.run_dir.new_dir('patchelf2'))
+
+ # lteue requires CAP_NET_ADMIN to create tunnel devices: ioctl(TUNSETIFF):
+ self.log('Applying CAP_NET_ADMIN capability to lteue')
+ util.setcap_net_admin(binary, self.run_dir.new_dir('setcap_net_admin'))
+ util.setcap_net_admin(self.inst.child('', 'lteue-*'), self.run_dir.new_dir('setcap_net_admin2'))
+
+ args = (binary, os.path.abspath(self.config_file))
+ self.dbg(run_dir=self.run_dir, binary=binary, env=env)
+ self.process = process.Process(self.name(), self.run_dir, args, env=env)
+ self.suite_run.remember_to_stop(self.process)
+ self.process.launch()
+
+ def gen_conf_file(self, path, filename, values):
+ self.dbg('AmarisoftUE ' + filename + ':\n' + pprint.pformat(values))
+ with open(path, 'w') as f:
+ r = template.render(filename, values)
+ self.dbg(r)
+ f.write(r)
+
+ def configure(self):
+ self.inst = util.Dir(os.path.abspath(self.bin_prefix()))
+ if not self.inst.isfile('', AmarisoftUE.BINFILE):
+ raise log.Error('No %s binary in' % AmarisoftUE.BINFILE, self.inst)
+
+ self.config_file = self.run_dir.child(AmarisoftUE.CFGFILE)
+ self.config_rf_file = self.run_dir.child(AmarisoftUE.CFGFILE_RF)
+ self.log_file = self.run_dir.child(AmarisoftUE.LOGFILE)
+ self.ifup_file = self.run_dir.new_file(AmarisoftUE.IFUPFILE)
+ os.chmod(self.ifup_file, 0o744) # add execution permission
+ with open(self.ifup_file, 'w') as f:
+ r = '''#!/bin/sh
+ set -x -e
+ ue_id="$1" # UE ID
+ pdn_id="$2" # PDN unique id (start from 0)
+ ifname="$3" # Interface name
+ ipv4_addr="$4" # IPv4 address
+ ipv4_dns="$5" # IPv4 DNS
+ ipv6_local_addr="$6" # IPv6 local address
+ ipv6_dns="$7" # IPv6 DNS
+ old_link_local=""
+ # script + sudoers file available in osmo-gsm-tester.git/utils/{bin,sudoers.d}
+ sudo /usr/local/bin/osmo-gsm-tester_netns_setup.sh "%s" "$ifname" "$ipv4_addr"
+ echo "${ue_id}: netns %s configured"
+ ''' % (self.netns(), self.netns())
+ f.write(r)
+
+ if not self.setup_runs_locally():
+ self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr)
+ remote_prefix_dir = util.Dir(AmarisoftUE.REMOTE_DIR)
+ self.remote_inst = util.Dir(remote_prefix_dir.child(os.path.basename(str(self.inst))))
+ remote_run_dir = util.Dir(remote_prefix_dir.child(AmarisoftUE.BINFILE))
+
+ self.remote_config_file = remote_run_dir.child(AmarisoftUE.CFGFILE)
+ self.remote_config_rf_file = remote_run_dir.child(AmarisoftUE.CFGFILE_RF)
+ self.remote_log_file = remote_run_dir.child(AmarisoftUE.LOGFILE)
+ self.remote_ifup_file = remote_run_dir.child(AmarisoftUE.IFUPFILE)
+
+ values = dict(ue=config.get_defaults('amarisoft'))
+ config.overlay(values, dict(ue=config.get_defaults('amarisoftue')))
+ config.overlay(values, dict(ue=self.suite_run.config().get('amarisoft', {})))
+ config.overlay(values, dict(ue=self.suite_run.config().get('modem', {})))
+ config.overlay(values, dict(ue=self._conf))
+ config.overlay(values, dict(ue=dict(num_antennas = self.enb.num_ports())))
+
+ logfile = self.log_file if self.setup_runs_locally() else self.remote_log_file
+ ifupfile = self.ifup_file if self.setup_runs_locally() else self.remote_ifup_file
+ config.overlay(values, dict(ue=dict(log_filename=logfile,
+ ifup_filename=ifupfile)))
+
+ # We need to set some specific variables programatically here to match IP addresses:
+ if self._conf.get('rf_dev_type') == 'zmq':
+ base_srate = num_prb2base_srate(self.enb.num_prb())
+ rf_dev_args = 'tx_port0=tcp://' + self.addr() + ':2001' \
+ + ',tx_port1=tcp://' + self.addr() + ':2003' \
+ + ',rx_port0=tcp://' + self.enb.addr() + ':2000' \
+ + ',rx_port1=tcp://' + self.enb.addr() + ':2002' \
+ + ',tx_freq=2510e6,rx_freq=2630e6,tx_freq2=2530e6,rx_freq2=2650e6' \
+ + ',id=ue,base_srate='+ str(base_srate)
+ config.overlay(values, dict(ue=dict(sample_rate = base_srate / (1000*1000),
+ rf_dev_args = rf_dev_args)))
+
+ # The UHD rf driver seems to require the bandwidth configuration
+ if self._conf.get('rf_dev_type') == 'uhd':
+ bandwidth = num_prb2bandwidth(self.enb.num_prb())
+ config.overlay(values, dict(ue=dict(bandwidth = bandwidth)))
+
+ # Set UHD frame size as a function of the cell bandwidth on B2XX
+ if self._conf.get('rf_dev_type') == 'uhd' and values['ue'].get('rf_dev_args', None) is not None:
+ if 'b200' in values['ue'].get('rf_dev_args'):
+ rf_dev_args = values['ue'].get('rf_dev_args', '')
+ rf_dev_args += ',' if rf_dev_args != '' and not rf_dev_args.endswith(',') else ''
+
+ if self.enb.num_prb() < 25:
+ rf_dev_args += 'send_frame_size=512,recv_frame_size=512'
+ elif self.enb.num_prb() == 25:
+ rf_dev_args += 'send_frame_size=1024,recv_frame_size=1024'
+ elif self.enb.num_prb() > 50:
+ rf_dev_args += 'num_recv_frames=64,num_send_frames=64'
+
+ # For 15 and 20 MHz, further reduce over the wire format to sc12
+ if self.enb.num_prb() >= 75:
+ rf_dev_args += ',otw_format=sc12'
+
+ config.overlay(values, dict(ue=dict(rf_dev_args=rf_dev_args)))
+
+ # rf driver is shared between amarisoft enb and ue, so it has a
+ # different cfg namespace 'trx'. Copy needed values over there:
+ config.overlay(values, dict(trx=dict(rf_dev_type=values['ue'].get('rf_dev_type', None),
+ rf_dev_args=values['ue'].get('rf_dev_args', None))))
+
+ self.gen_conf_file(self.config_file, AmarisoftUE.CFGFILE, values)
+ self.gen_conf_file(self.config_rf_file, AmarisoftUE.CFGFILE_RF, values)
+
+ if not self.setup_runs_locally():
+ self.rem_host.recreate_remote_dir(self.remote_inst)
+ self.rem_host.scp('scp-inst-to-remote', str(self.inst), remote_prefix_dir)
+ self.rem_host.recreate_remote_dir(remote_run_dir)
+ self.rem_host.scp('scp-cfg-to-remote', self.config_file, self.remote_config_file)
+ self.rem_host.scp('scp-cfg-rf-to-remote', self.config_rf_file, self.remote_config_rf_file)
+ self.rem_host.scp('scp-ifup-to-remote', self.ifup_file, self.remote_ifup_file)
+
+ def is_connected(self, mcc_mnc=None):
+ # lteue doesn't call the ifup script until after it becomes attached, so
+ # simply look for our ifup script output at the end of it:
+ return 'netns %s configured' % (self.netns()) in (self.process.get_stdout() or '')
+
+ def is_attached(self):
+ return self.is_connected()
+
+ def running(self):
+ return not self.process.terminated()
+
+ def addr(self):
+ return self._addr
+
+ def run_node(self):
+ return RunNode(RunNode.T_REM_SSH, self._addr, self.remote_user, self._addr)
+
+ def run_netns_wait(self, name, popen_args):
+ if self.setup_runs_locally():
+ proc = process.NetNSProcess(name, self.run_dir.new_dir(name), self.netns(), popen_args, env={})
+ else:
+ proc = self.rem_host.RemoteNetNSProcess(name, self.netns(), popen_args, env={})
+ proc.launch_sync()
+ return proc
+
+ def verify_metric(self, value, operation='avg', metric='dl_brate', criterion='gt'):
+ return 'metrics not yet implemented with Amarisoft UE'
+
+# vim: expandtab tabstop=4 shiftwidth=4