osmo-gsm-tester/src/osmo_gsm_tester/srs_enb.py

198 lines
8.3 KiB
Python

# osmo_gsm_tester: specifics for running an SRS eNodeB 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 . import log, util, config, template, process, remote
class srsENB(log.Origin):
REMOTE_DIR = '/osmo-gsm-tester-srsenb'
BINFILE = 'srsenb'
CFGFILE = 'srsenb.conf'
CFGFILE_SIB = 'srsenb_sib.conf'
CFGFILE_RR = 'srsenb_rr.conf'
CFGFILE_DRB = 'srsenb_drb.conf'
LOGFILE = 'srsenb.log'
def __init__(self, suite_run, conf):
super().__init__(log.C_RUN, 'srsenb')
self._addr = conf.get('addr', None)
if self._addr is None:
raise log.Error('addr not set')
self.set_name('srsenb_%s' % self._addr)
self.ue = None
self.epc = None
self.run_dir = None
self.config_file = None
self.config_sib_file = None
self.config_rr_file = None
self.config_drb_file = None
self.process = None
self.rem_host = None
self.remote_config_file = None
self.remote_config_sib_file = None
self.remote_config_rr_file = None
self.remote_config_drb_file = None
self.remote_log_file = None
self.suite_run = suite_run
self.nof_prb=100
if self.nof_prb == 75:
self.base_srate=15.36e6
else:
self.base_srate=23.04e6
self.remote_user = conf.get('remote_user', None)
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 start(self, epc):
self.log('Starting srsENB')
self.epc = epc
self.run_dir = util.Dir(self.suite_run.get_test_run_dir().new_dir(self.name()))
self.configure()
if self.remote_user:
self.start_remotely()
else:
self.start_locally()
def start_remotely(self):
self.inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte')))
lib = self.inst.child('lib')
if not os.path.isdir(lib):
raise log.Error('No lib/ in', self.inst)
if not self.inst.isfile('bin', srsENB.BINFILE):
raise log.Error('No %s binary in' % srsENB.BINFILE, self.inst)
self.rem_host = remote.RemoteHost(self.run_dir, self.remote_user, self._addr)
remote_prefix_dir = util.Dir(srsENB.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(srsENB.BINFILE))
self.remote_config_file = remote_run_dir.child(srsENB.CFGFILE)
self.remote_config_sib_file = remote_run_dir.child(srsENB.CFGFILE_SIB)
self.remote_config_rr_file = remote_run_dir.child(srsENB.CFGFILE_RR)
self.remote_config_drb_file = remote_run_dir.child(srsENB.CFGFILE_DRB)
self.remote_log_file = remote_run_dir.child(srsENB.LOGFILE)
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.create_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-sib-to-remote', self.config_sib_file, self.remote_config_sib_file)
self.rem_host.scp('scp-cfg-rr-to-remote', self.config_rr_file, self.remote_config_rr_file)
self.rem_host.scp('scp-cfg-drb-to-remote', self.config_drb_file, self.remote_config_drb_file)
remote_env = { 'LD_LIBRARY_PATH': self.remote_inst.child('lib') }
remote_binary = self.remote_inst.child('bin', srsENB.BINFILE)
args = (remote_binary, self.remote_config_file,
'--enb_files.sib_config=' + self.remote_config_sib_file,
'--enb_files.rr_config=' + self.remote_config_rr_file,
'--enb_files.drb_config=' + self.remote_config_drb_file,
'--rf.device_name=zmq',
'--rf.device_args="fail_on_disconnect=true,tx_port=tcp://'+ self.addr() +':2000,rx_port=tcp://'+ self.ue.addr() +':2001,id=enb,base_srate='+ str(self.base_srate) + '"',
'--expert.nof_phy_threads=1',
'--expert.rrc_inactivity_timer=1500',
'--enb.n_prb=' + str(self.nof_prb),
'--log.filename=' + self.remote_log_file)
self.process = self.rem_host.RemoteProcessFixIgnoreSIGHUP(srsENB.BINFILE, util.Dir(srsENB.REMOTE_DIR), args, remote_env=remote_env)
self.suite_run.remember_to_stop(self.process)
self.process.launch()
def start_locally(self):
inst = util.Dir(os.path.abspath(self.suite_run.trial.get_inst('srslte')))
binary = inst.child('bin', BINFILE)
if not os.path.isfile(binary):
raise log.Error('Binary missing:', binary)
lib = inst.child('lib')
if not os.path.isdir(lib):
raise log.Error('No lib/ in', inst)
env = { 'LD_LIBRARY_PATH': util.prepend_library_path(lib) }
self.dbg(run_dir=self.run_dir, binary=binary, env=env)
args = (binary, os.path.abspath(self.config_file),
'--enb_files.sib_config=' + os.path.abspath(self.config_sib_file),
'--enb_files.rr_config=' + os.path.abspath(self.config_rr_file),
'--enb_files.drb_config=' + os.path.abspath(self.config_drb_file),
'--rf.device_name=zmq',
'--rf.device_args="fail_on_disconnect=true,tx_port=tcp://'+ self.addr() +':2000,rx_port=tcp://'+ self.ue.addr() +':2001,id=enb,base_srate='+ str(self.base_srate) + '"',
'--expert.nof_phy_threads=1',
'--expert.rrc_inactivity_timer=1500',
'--enb.n_prb=' + str(self.nof_prb),
'--log.filename=' + self.log_file)
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):
self.dbg(config_file=path)
values = dict(enb=config.get_defaults('srsenb'))
config.overlay(values, self.suite_run.config())
config.overlay(values, dict(enb={ 'run_addr': self.addr(),
'mme_addr': self.epc.addr()}))
self.dbg('srsENB ' + 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.config_file = self.run_dir.new_file(srsENB.CFGFILE)
self.config_sib_file = self.run_dir.new_file(srsENB.CFGFILE_SIB)
self.config_rr_file = self.run_dir.new_file(srsENB.CFGFILE_RR)
self.config_drb_file = self.run_dir.new_file(srsENB.CFGFILE_DRB)
self.log_file = self.run_dir.new_file(srsENB.LOGFILE)
self.gen_conf_file(self.config_file, srsENB.CFGFILE)
self.gen_conf_file(self.config_sib_file, srsENB.CFGFILE_SIB)
self.gen_conf_file(self.config_rr_file, srsENB.CFGFILE_RR)
self.gen_conf_file(self.config_drb_file, srsENB.CFGFILE_DRB)
def ue_add(self, ue):
if self.ue is not None:
raise log.Error("More than one UE per ENB not yet supported (ZeroMQ)")
self.ue = ue
def running(self):
return not self.process.terminated()
def addr(self):
return self._addr
# vim: expandtab tabstop=4 shiftwidth=4